Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-29-8"

Query Parameters

account_id
string
required

Account ID, prefixed biz_.

status
enum<string>

Only return members with this status: joined (accepted members) or pending (pending invites). Both are returned by default.

Available options:
joined,
pending
user_id
string

Only return the membership for this user ID, prefixed user_.

role
enum<string>

Only return members with this role. custom matches members on a dashboard-managed custom role.

Available options:
owner,
admin,
partner,
sales_manager,
moderator,
advertiser,
app_manager,
support,
manager,
workforce,
custom
query
string

Only return members whose name or username contains this text, and invites whose email contains it.

reports_to_id
string

Only return the direct reports of this team member, whose ID may start with ausr_ or mber_. Pass the account ID, prefixed biz_, for the members who report to the business directly. Pending invites are excluded, and the list pages in created_at order without moving Partner-role members last.

direct_reports_min
integer

Only return members with at least this many direct reports. Pending invites are excluded, and the list pages in created_at order without moving Partner-role members last.

Required range: x >= 0
direct_reports_max
integer

Only return members with at most this many direct reports; 0 returns the people who manage no one. Pending invites are excluded, and the list pages in created_at order without moving Partner-role members last.

Required range: x >= 0
created_before
string

Only return members added before this ISO 8601 timestamp.

created_after
string

Only return members added after this ISO 8601 timestamp.

order
enum<string>
default:created_at

Field used to sort members. Members with the view-only Partner role are listed after all other members whichever way the list is sorted.

Available options:
created_at
direction
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc
first
integer
default:20

Number of results to return from the start of the range.

Required range: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Required range: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

Team members listed.

data
object[]
required
page_info
object
required