A valid request URL is required to generate request examples{
"members": [
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>",
"role": "owner",
"role_name": "Owner",
"joined_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List a team's members
Who is on this team, oldest membership first — the roster behind every “members” screen a B2B product has, and the read that had no server-side source before it.
Each row carries the role’s key and its display name. Gate on what the role GRANTS rather than on its key: the grant travels in the session JWT’s customer_permissions, and the catalogue itself is at GET /v1/organization/customer-roles.
Pending invitations are not here. A seat that was offered is offered and revoked from inside the team (GET /v1/contact/customer/members answers both halves to somebody who is on it), and a program mirroring an account structure wants the roster it enforces rather than the one somebody is halfway through joining.
A valid request URL is required to generate request examples{
"members": [
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>",
"role": "owner",
"role_name": "Owner",
"joined_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
An organization API key, uk_sk_live_… or uk_sk_test_…. The environment is resolved from the stored key row on every request, never from a request parameter.
Every route behind this credential is rate limited per key — 1000 requests a minute — with a second ceiling of 3000 a minute across all the keys of one environment, so splitting your traffic across keys isolates it and minting more keys does not buy more of it. A test key can never spend a live key's allowance. Every response carries the current state in headers; see the rate-limits guide.
Parâmetros de caminho
The team.
Resposta
The members.
Show child attributes
Show child attributes