Sign in
Invitations (iam/v2)

List of Invitations

General Availability

Retrieve a sorted, filtered, paginated list of all invitations.

get/iam/v2/invitations

Query parameters

emailstring

Filter a collection by a string search

Filter the results by exact match for email.

statusstring

Filter a collection by a string search

Filter the results by exact match for status.

userstring

Filter a collection by a string search

Filter the results by exact match for user.

creatorstring

Filter a collection by a string search

Filter the results by exact match for creator.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Invitation.

api_version'iam/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'InvitationList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/iam/v2/invitations",
    "last": "https://api.confluent.cloud/iam/v2/invitations?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/iam/v2/invitations?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/iam/v2/invitations?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/iam/v2/invitations/i-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/invitation=i-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "email": "johndoe@confluent.io",
      "auth_type": "AUTH_TYPE_SSO",
      "status": "INVITE_STATUS_SENT",
      "accepted_at": "2022-07-06T17:21:33Z",
      "expires_at": "2022-07-07T17:22:39Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.