Use the Memberships API to retrieve a list of users belonging to an organization, including organization and team IDs.
Retrieve a list of memberships
Use this endpoint to retrieve all users defined in a specified organization’s team:
GET /v3/organizations/{organization_id}/memberships
| Parameter name | In | Type | Required? | Description |
|---|---|---|---|---|
|
Path |
String |
Yes |
The ID of the organization. |
Responses
The following table outlines the possible responses for this endpoint, including status codes, their meanings, and the schemas that describe the returned data or errors:
| Status Code | Description | Schema |
|---|---|---|
200 |
Success. Returns a list of memberships for the specified organization. |
|
Default |
Error. Occurs when the |
|
{ "memberships": [{ "id": "<1>", "user_id": "<1>", "team_id":”<1>", "active":”<true>", "audit": { “who”: ”<1>", “when”: ”<timestamp>", “why”: ”<reason for the update> } }] }
Remove user from team membership
Use the Remove Membership API to send a request to remove users from a team.
POST /v1/organizations/{organization_id}/memberships/{team_id}/remove
| Parameter name | In | Type | Required? | Description |
|---|---|---|---|---|
|
Path |
String |
Yes |
The ID of the organization. |
|
Path |
String |
Yes |
The ID of the team. |
Responses
The following table outlines the possible responses for this endpoint, including status codes, their meanings, and the schemas that describe the returned data or errors:
| Status Code | Description | Schema |
|---|---|---|
200 |
Success. Requests user removal from membership. |
|
Default |
Error. Occurs when the |
|