Get Invite

get /v1/organizations/invites/{invite_id}

Get Invite

Path Parameters

  • invite_id: string

    ID of the Invite.

Returns

  • Invite object { id, email, expires_at, 4 more }

    • id: string

      ID of the Invite.

    • email: string

      Email of the User being invited.

    • expires_at: string

      RFC 3339 datetime string indicating when the Invite expires.

    • invited_at: string

      RFC 3339 datetime string indicating when the Invite was created.

    • role: "user" or "developer" or "billing" or 2 more

      Organization role of the User.

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • status: "accepted" or "expired" or "deleted" or "pending"

      Status of the Invite.

      • "accepted"

      • "expired"

      • "deleted"

      • "pending"

    • type: "invite"

      Object type.

      For Invites, this is always "invite".

      • "invite"

Example

curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

Response

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "type": "invite"
}