Skip to main content
GET
TypeScript

인증

Authorization
string
header
필수

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.

Scopes

company:authorized_user:read

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

쿼리 매개변수

account_id
string

Only return the team of this account, prefixed biz_. A signed-in user can omit it only with user_id=me or their own user ID. An API key that omits it gets its own account. reports_to_id, direct_reports_min and direct_reports_max need it.

status
enum<string>

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

사용 가능한 옵션:
joined,
pending
user_id
string

Only return the memberships of this user ID, prefixed user_. Pass me for the signed-in user.

user_ids
string[]

Only return the memberships of these users, prefixed user_, at most 100. IDs that match no user are ignored. With account_id=global, a user can have one in each partner account. Can't be combined with user_id.

role
enum<string>

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

사용 가능한 옵션:
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.

필수 범위: 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.

필수 범위: x >= 0
team_lead_id
string

Only return this user, prefixed user_, and everyone under them in today's org chart: the same team the stats API's team_lead_id reads. With account_id=global, their line in every partner account where they hold a role. Pending invites are excluded, and the list pages in created_at order without moving Partner-role members last.

has_referred_businesses
boolean

When true, only members who referred at least one business for their account; when false, only members who referred none. Pending invites are excluded, and the list pages in created_at order without moving Partner-role members last.

is_partner
boolean

When true, only members and invites with the view-only Partner role. When false, only the ones without it.

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>
기본값: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.

사용 가능한 옵션:
created_at
direction
enum<string>
기본값:desc

Sort direction. Defaults to desc.

사용 가능한 옵션:
asc,
desc
first
integer
기본값:20

Number of results to return from the start of the 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.

필수 범위: x <= 100
before
string

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

응답

Team members listed.

data
object[]
필수
page_info
object
필수