Organization Invitations

Retrieve an organization invitation by ID

Changed on

Use this request to get an existing organization invitation by ID.

get/organizations/{organization_id}/invitations/{invitation_id}

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/organizations/{organization_id}/invitations/{invitation_id}
  • Auth: HTTP bearer

Path parameters

organization_idstring required

The organization ID.

invitation_idstring required

The organization invitation ID.

Response

An organization invitation

object'organization_invitation' required

String representing the object's type. Objects of the same type share the same value.

idstring required
email_addressstring required
rolestring required
role_namestring required
organization_idstring
inviter_idstring nullable required
statusstring
public_metadataobject required
private_metadataobject
urlstring nullable required
expires_atinteger nullable required

Unix timestamp of expiration.

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Changes