Skip to main content
GET
TypeScript

Autorisationer

Authorization
string
header
påkrævet

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

member:basic:read

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Forespørgselsparametre

account_id
string

The account to list members for (biz_ tag). Defaults to the account the credential acts as.

access_level
enum<string>

Filter by what the member can reach on the account.

Tilgængelige muligheder:
no_access,
admin,
customer
status
enum<string>

Filter by whether the member is still part of the account.

Tilgængelige muligheder:
joined,
left
user_ids
string[]

Only return members whose users match these user_ identifiers.

most_recent_actions
enum<string>[]

Only return members whose most_recent_action is one of these values.

Tilgængelige muligheder:
canceling,
churned,
finished_split_pay,
paused,
paid_subscriber,
paid_once,
expiring,
joined,
left,
trialing,
pending_entry,
renewing,
past_due
membership_status
enum<string>

active returns members holding at least one membership that currently grants access; inactive returns members holding at least one membership that does not. Combined with product_ids, variant_ids, or promo_code_ids, one membership must match all of them.

Tilgængelige muligheder:
active,
inactive
product_ids
string[]

Only return members holding a membership to one of these products, prefixed prod_. Unknown IDs match nothing.

variant_ids
string[]

Only return members holding a membership on one of these variants, prefixed plan_. Unknown IDs match nothing.

promo_code_ids
string[]

Only return members holding a membership bought with one of these promo codes, prefixed promo_. Unknown IDs match nothing.

query
string

Search members by name or username. An exact email address also matches when the credential holds the member:email:read scope.

created_after
string

Only members who joined after this ISO 8601 timestamp.

created_before
string

Only members who joined before this ISO 8601 timestamp.

order
enum<string>
standard:created_at

Sort field. most_recent_action_at and last_activity_at place members without one first when ascending and last when descending. needs_reply lists customers awaiting a support reply first, ordered by their latest qualifying message. Other members follow in last-activity order. Direction applies within each group. Requires support_chat:read.

Tilgængelige muligheder:
created_at,
joined_at,
last_accessed_at,
last_activity_at,
most_recent_action_at,
usd_total_spent,
needs_reply
direction
enum<string>
standard:desc

Sort direction.

Tilgængelige muligheder:
asc,
desc
first
integer
standard:20

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

Nødvendigt interval: 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.

Nødvendigt interval: x <= 100
before
string

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

include_total_count
boolean

Set to true to return the number of matching results in page_info.total_count. Send first=0 as well to return the count without any results.

Svar

members listed

data
object[]
påkrævet
page_info
object
påkrævet