Skip to main content
POST
List workspace members

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Query Parameters

workspaceId
string | null

ID of the workspace. With a personal access token, use the token's workspace, which is also the default. From a signed-in session it defaults to your active workspace. Get it from organization_id in Get app.

Minimum string length: 1

Body

application/json

One page of a members list.

search
string | null

Text to match, ignoring case, anywhere in a member's email, name, role, or status.

Maximum string length: 256
Example:

"acme.com"

search_terms
string[] | null

More text to match the same way as search, up to 200 terms. A member matches when any term does.

Maximum array length: 200
Maximum string length: 256
Example:
sort_by
enum<string> | null

Column to sort by: member (name, or email when there's no name), credits (credits_used), apps and agents (owned plus shared), last_active, or role (owner, admin, editor, viewer, guest). Needs sort_dir.

Available options:
member,
credits,
apps,
agents,
last_active,
role
Example:

"last_active"

sort_dir
enum<string> | null

Sort direction. Needs sort_by.

Available options:
asc,
desc
Example:

"desc"

roles
string[] | null

Only members with one of these roles: owner, admin, editor, viewer, or guest.

Maximum array length: 20
Example:
invite_statuses
enum<string>[] | null

Only people in one of these states: joined, pending (invited and not yet joined), or expired (the invitation lapsed).

Maximum array length: 3
Available options:
joined,
pending,
expired
Example:
credit_limit_set
boolean | null

true for only members with their own credit limit, false for only members without one. A member on the workspace default counts as not having their own.

Example:

true

apps_owned
MembersNumberRangeFilter · object | null

Only members whose apps_owned plus apps_shared is in this range.

agents_owned
MembersNumberRangeFilter · object | null

Only members whose agents_owned plus agents_shared is in this range.

last_active
MembersDateRangeFilter · object | null

Only members whose last_active is in this range. Members who never used credits don't match.

cursor
string | null

next_cursor from the previous page. Leave it out for the first page.

Maximum string length: 256
Example:

"NTA="

page_size
integer
default:50

How many people to return, 1 to 100. Defaults to 50.

Required range: 1 <= x <= 100
Example:

50

Response

One page of members.

One page of workspace members.

members
WorkspaceMemberRow · object[]
required

The people on this page.

Example:
next_cursor
string | null
required

Pass as cursor to get the next page. null on the last page.

Example:

"NTA="

has_more
boolean
default:false
required

true when there's another page.

Example:

true

total
integer
default:0
required

Number of people matching the filters, across all pages.

Example:

137

monthly_limit
integer | null
required

The workspace's monthly credits, or null when they're unlimited.

Example:

10000

default_member_credit_limit
integer | null
required

The workspace's default member credit limit, or null when none is set.

Example:

300