List Invites
api/admin/invites/list
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/invites/list Changed · +18 / -13 lines
# List Invites ## Query parameters ## Returns ## Example ### Response (200) ## List Invites ### Query Parameters ### Returns ### Example #### Response
---- -title: List Invites -url: https://platform.claude.com/docs/en/api/admin/invites/list ---- +# List Invites -## List Invites +**GET** `/v1/organizations/invites` -**get** `/v1/organizations/invites` - For Claude Enterprise organizations, this endpoint's availability is in beta. -### Query Parameters +## Query parameters - `after_id: optional string`
Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + format: email + - `limit: optional number` Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`. + default: 20, maximum: 1000, minimum: 1 + - `roles: optional array of string` Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
- `"pending"` -### Returns +## Returns - `data: array of Invite`
RFC 3339 datetime string indicating when the Invite was accepted, or null. + format: date-time + - `email: string` Email of the User being invited.
RFC 3339 datetime string indicating when the Invite expires. + format: date-time + - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. + format: date-time + - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
For Invites, this is always `"invite"`. - - `"invite"` + default: invite - `first_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page. -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/invites \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +### Response (200) ```json {