Skip to main content
GET
List team members

Authorizations

Authorization
string
header
required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Query Parameters

limit
integer
default:25

Page size, 1-100. Default 25.

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

Cursor: object id from the previous page (forward walk). Numeric offset or page parameters are not supported; cursors are the only supported paging mechanism.

ending_before
string

Cursor: object id from the previous page (reverse walk).

role
enum<string>

Filter: admin, manager, scanner.

Available options:
admin,
manager,
scanner
status
enum<string>

Lifecycle filter. Default (omitted) returns invited + active only - terminal states must be asked for explicitly.

Available options:
invited,
active,
revoked,
expired
location_id
string

Members whose scope includes this location.

email
string

Exact-match email lookup.

Response

The team member object.

Standard cursor-pagination envelope for list endpoints. See the Pagination guide.

object
string
required

Always "list".

Allowed value: "list"
data
object[]
required

Array of the requested resource type.

has_more
boolean
required

True when more pages exist - pass the last item id as starting_after.

next_cursor
string | null

Cursor for the next page in the direction you are already paging, or null when this page ends the collection. has_more: true always comes with a non-null next_cursor.

Feed it back to the SAME parameter you used: starting_after when paging forward (the default), or ending_before when paging backward. Treat it as opaque and do not parse it.

You no longer need to take the last object's id yourself. That still works and is unchanged, but deriving the cursor from the page put the burden of knowing the sort direction on you, and it broke silently on any endpoint whose cursor is not the object id.

Example:

"cus_iofv5j4hn6bphinmmyat27tc5y"

url
string

Stable collection URL.

Allowed value: "/v1/team_members"