Skip to main content
GET
List members

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Query Parameters

page
integer
default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000
perPage
integer
default:25

Items per page, 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100
sort
string

One sort field; prefix - for descending (sort=field or sort=-field). Allowed: createdAt, email, acceptedAt. Default -createdAt. The server appends id as a tie-breaker.

Example:

"-createdAt"

Case-insensitive search (at most 255 characters) over email, displayName.

Maximum string length: 255
filter[status]
enum<string>

Membership status (equals).

Available options:
invited,
active,
suspended,
removed
filter[status][in]
string

Membership status (one of (comma-separated)). Comma-separated values.

filter[groupId]
integer

Member of this group (equals).

Required range: x >= 0
filter[provisionedVia]
enum<string>

How the membership was created (equals).

Available options:
invite,
sso-jit,
admin
filter[mfaEnrolled]
boolean

Has a second factor (equals).

filter[createdAt][gt]
string<date-time>

Creation time (download key) (greater than).

filter[createdAt][gte]
string<date-time>

Creation time (download key) (greater than or equal).

filter[createdAt][lt]
string<date-time>

Creation time (download key) (less than).

filter[createdAt][lte]
string<date-time>

Creation time (download key) (less than or equal).

Response

OK

Page envelope of PartnerMembership items.

data
object
required

The page.