List Invites

InviteListPage beta().organization().invites().list(, )

GET/v1/organizations/invites

List the organization's invites.

Parameters

InviteListParams params

Optional<String> afterId

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

Optional<String> beforeId

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

Optional<String> email

Filter by the email address the Invite was sent to. Matches the same way as the Users list's email filter (normalized, case-insensitive).

formatemail

Optional<Long> limit

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

maximum1000

minimum1

Optional<List<String>> roles

Filter to items whose role equals one of the supplied values. Repeatable; values are OR'ed together.

Accepted values depend on the organization type: Console and API organizations accept user, developer, billing, admin, and claude_code_user; Claude Enterprise organizations accept user, owner, primary_owner, membership_admin, and managed.

Optional<List<Status>> statuses

Filter by Invite status. Repeatable; values are OR'ed together. Omit to return pending, accepted, and expired Invites alike.

ACCEPTED("accepted")

EXPIRED("expired")

PENDING("pending")

Returns

class BetaOrganizationInvite:

List Invites

package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.organization.invites.InviteListPage;
import com.anthropic.models.beta.organization.invites.InviteListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        InviteListPage page = client.beta().organization().invites().list();
    }
}

{
  "data": [
    {
      "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
      "accepted_at": "2019-12-27T18:11:19.117Z",
      "email": "user@emaildomain.com",
      "expires_at": "2024-11-20T23:58:27.427722Z",
      "invited_at": "2024-10-30T23:58:27.427722Z",
      "rbac_group_ids": [
        "string"
      ],
      "role": "admin",
      "status": "pending",
      "type": "invite"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Returns Examples

{
  "data": [
    {
      "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
      "accepted_at": "2019-12-27T18:11:19.117Z",
      "email": "user@emaildomain.com",
      "expires_at": "2024-11-20T23:58:27.427722Z",
      "invited_at": "2024-10-30T23:58:27.427722Z",
      "rbac_group_ids": [
        "string"
      ],
      "role": "admin",
      "status": "pending",
      "type": "invite"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}