Organisations
List an organisation's members
Each member's account id, email address, role, and join date.
GET
/orgs/{org}/membersTL;DR
| Question | Answer |
|---|---|
| What does it do? | List an organisation's members. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrganisationMemberList. |
| What can go wrong? | 401 not signed in; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Each member's account id, email address, role, and join date. Every member sees the addresses: a team knows who is in it.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The members. | OrganisationMemberList |
| 401 | Not signed in. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type OrganisationMemberList.
| Field | Type | Required | Description |
|---|---|---|---|
items | OrganisationMember[] | yes | |
items[].userId | string | yes | |
items[].email | string | yes | Shown to every member: a team knows who is in it. |
items[].role | "owner" | "admin" | "member" | "reader" | yes | |
items[].joinedAt | integer | yes | Milliseconds since the epoch. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |