SPB Git

Repository Public

retrieve.md 2.0 KB 119 lines markdown

1---2title: Get Invite3url: https://platform.claude.com/docs/en/api/beta/organization/invites/retrieve4---56# Get Invite78**GET** `/v1/organizations/invites/{invite_id}`910Retrieve an invite by ID.1112## Path parameters1314- `invite_id: string`1516  ID of the Invite.1718## Returns1920- `BetaOrganizationInvite object`2122  - `type: "invite"`2324    Object type.2526    For Invites, this is always `"invite"`.2728    default: invite2930  - `id: string`3132    ID of the Invite.3334  - `accepted_at: string or null`3536    RFC 3339 datetime string indicating when the Invite was accepted, or null.3738    format: date-time3940  - `email: string`4142    Email of the User being invited.4344  - `expires_at: string`4546    RFC 3339 datetime string indicating when the Invite expires.4748    format: date-time4950  - `invited_at: string`5152    RFC 3339 datetime string indicating when the Invite was created.5354    format: date-time5556  - `rbac_group_ids: array of string`5758    RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.5960  - `role: BetaOrganizationRole`6162    Organization role of the User.6364    - `"admin"`6566    - `"billing"`6768    - `"claude_code_user"`6970    - `"developer"`7172    - `"managed"`7374    - `"membership_admin"`7576    - `"owner"`7778    - `"primary_owner"`7980    - `"user"`8182  - `status: "accepted" or "deleted" or "expired" or "pending"`8384    Status of the Invite.8586    - `"accepted"`8788    - `"deleted"`8990    - `"expired"`9192    - `"pending"`9394## Example9596```bash97curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \98    -H 'anthropic-version: 2023-06-01' \99    -H "X-Api-Key: $ANTHROPIC_API_KEY"100```101102### Response (200)103104```json105{106  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",107  "accepted_at": "2019-12-27T18:11:19.117Z",108  "email": "user@emaildomain.com",109  "expires_at": "2024-11-20T23:58:27.427722Z",110  "invited_at": "2024-10-30T23:58:27.427722Z",111  "rbac_group_ids": [112    "string"113  ],114  "role": "admin",115  "status": "pending",116  "type": "invite"117}118```119
Files main
Menu

Theme