from line 1
1---
2title: Invites
3url: https://platform.claude.com/docs/en/api/admin/invites
4---
5
61# Invites
72
83## Create Invite
94
10**post** `/v1/organizations/invites`
5**POST** `/v1/organizations/invites`
116
127For Claude Enterprise organizations, this endpoint's availability is in beta.
138
149On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat.
1510
16### Body Parameters
11### Body parameters
1712
1813- `email: string`
1914
2015 Email of the User.
2116
17 format: email
18
2219- `role: "billing" or "claude_code_user" or "developer" or 2 more`
2320
2421 Role for the invited User.
from line 36
3936
4037 RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups (beta), and requires the key to carry the `write:rbac_groups` scope.
4138
39 maxItems: 100
40
4241### Returns
4342
44- `Invite object { id, accepted_at, email, 6 more }`
43- `Invite object`
4544
4645 - `id: string`
4746
from line 50
5150
5251 RFC 3339 datetime string indicating when the Invite was accepted, or null.
5352
53 format: date-time
54
5455 - `email: string`
5556
5657 Email of the User being invited.
from line 60
5960
6061 RFC 3339 datetime string indicating when the Invite expires.
6162
63 format: date-time
64
6265 - `invited_at: string`
6366
6467 RFC 3339 datetime string indicating when the Invite was created.
6568
69 format: date-time
70
6671 - `rbac_group_ids: array of string`
6772
6873 RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
from line 112
107112
108113 For Invites, this is always `"invite"`.
109114
110 - `"invite"`
115 default: invite
111116
112117### Example
113118
114```http
119```bash
115120curl https://api.anthropic.com/v1/organizations/invites \
116121 -H 'Content-Type: application/json' \
117122 -H 'anthropic-version: 2023-06-01' \
from line 127
122127 }'
123128```
124129
125#### Response
130#### Response (200)
126131
127132```json
128133{
from line 147
142147
143148## Get Invite
144149
145**get** `/v1/organizations/invites/{invite_id}`
150**GET** `/v1/organizations/invites/{invite_id}`
146151
147152For Claude Enterprise organizations, this endpoint's availability is in beta.
148153
149### Path Parameters
154### Path parameters
150155
151156- `invite_id: string`
152157
from line 159
154159
155160### Returns
156161
157- `Invite object { id, accepted_at, email, 6 more }`
162- `Invite object`
158163
159164 - `id: string`
160165
from line 169
164169
165170 RFC 3339 datetime string indicating when the Invite was accepted, or null.
166171
172 format: date-time
173
167174 - `email: string`
168175
169176 Email of the User being invited.
from line 179
172179
173180 RFC 3339 datetime string indicating when the Invite expires.
174181
182 format: date-time
183
175184 - `invited_at: string`
176185
177186 RFC 3339 datetime string indicating when the Invite was created.
178187
188 format: date-time
189
179190 - `rbac_group_ids: array of string`
180191
181192 RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
from line 231
220231
221232 For Invites, this is always `"invite"`.
222233
223 - `"invite"`
234 default: invite
224235
225236### Example
226237
227```http
238```bash
228239curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
229240 -H 'anthropic-version: 2023-06-01' \
230241 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
231242```
232243
233#### Response
244#### Response (200)
234245
235246```json
236247{
from line 261
250261
251262## List Invites
252263
253**get** `/v1/organizations/invites`
264**GET** `/v1/organizations/invites`
254265
255266For Claude Enterprise organizations, this endpoint's availability is in beta.
256267
257### Query Parameters
268### Query parameters
258269
259270- `after_id: optional string`
260271
from line 279
268279
269280 Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive).
270281
282 format: email
283
271284- `limit: optional number`
272285
273286 Number of items to return per page.
from line 287
274287
275288 Defaults to `20`. Ranges from `1` to `1000`.
276289
290 default: 20, maximum: 1000, minimum: 1
291
277292- `roles: optional array of string`
278293
279294 Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
from line 317
302317
303318 RFC 3339 datetime string indicating when the Invite was accepted, or null.
304319
320 format: date-time
321
305322 - `email: string`
306323
307324 Email of the User being invited.
from line 327
310327
311328 RFC 3339 datetime string indicating when the Invite expires.
312329
330 format: date-time
331
313332 - `invited_at: string`
314333
315334 RFC 3339 datetime string indicating when the Invite was created.
316335
336 format: date-time
337
317338 - `rbac_group_ids: array of string`
318339
319340 RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
from line 379
358379
359380 For Invites, this is always `"invite"`.
360381
361 - `"invite"`
382 default: invite
362383
363384- `first_id: string or null`
364385
from line 395
374395
375396### Example
376397
377```http
398```bash
378399curl https://api.anthropic.com/v1/organizations/invites \
379400 -H 'anthropic-version: 2023-06-01' \
380401 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
381402```
382403
383#### Response
404#### Response (200)
384405
385406```json
386407{
from line 428
407428
408429## Delete Invite
409430
410**delete** `/v1/organizations/invites/{invite_id}`
431**DELETE** `/v1/organizations/invites/{invite_id}`
411432
412433For Claude Enterprise organizations, this endpoint's availability is in beta.
413434
414### Path Parameters
435### Path parameters
415436
416437- `invite_id: string`
417438
from line 450
429450
430451 For Invites, this is always `"invite_deleted"`.
431452
432 - `"invite_deleted"`
453 default: invite_deleted
433454
434455### Example
435456
436```http
457```bash
437458curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
438459 -X DELETE \
439460 -H 'anthropic-version: 2023-06-01' \
from line 461
440461 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
441462```
442463
443#### Response
464#### Response (200)
444465
445466```json
446467{
from line 470
449470}
450471```
451472
452## Domain Types
473## Domain types
453474
454475### Invite
455476
456- `Invite object { id, accepted_at, email, 6 more }`
477- `Invite object`
457478
458479 - `id: string`
459480
from line 484
463484
464485 RFC 3339 datetime string indicating when the Invite was accepted, or null.
465486
487 format: date-time
488
466489 - `email: string`
467490
468491 Email of the User being invited.
from line 494
471494
472495 RFC 3339 datetime string indicating when the Invite expires.
473496
497 format: date-time
498
474499 - `invited_at: string`
475500
476501 RFC 3339 datetime string indicating when the Invite was created.
477502
503 format: date-time
504
478505 - `rbac_group_ids: array of string`
479506
480507 RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
from line 546
519546
520547 For Invites, this is always `"invite"`.
521548
522 - `"invite"`
549 default: invite
523550
524551### Invite Delete Response
525552
526- `InviteDeleteResponse object { id, type }`
553- `InviteDeleteResponse object`
527554
528555 - `id: string`
529556
from line 562
535562
536563 For Invites, this is always `"invite_deleted"`.
537564
538 - `"invite_deleted"`
565 default: invite_deleted
539566
No line in this hunk matches that.