Clerk API (unofficial showcase)
GET/invitations

List all invitations

Returns all non-revoked invitations for your application, sorted by creation date

6 parameters
statusstringoptional
Filter invitations based on their status
Allowed:pendingacceptedrevokedexpired
querystringoptional
Filter invitations based on their `email_address` or `id`
order_bystringoptional
Allows to return invitations in a particular order. At the moment, you can order the returned invitations either by their `created_at`, `email_address` or `expires_at`. In order to specify the direction, you can use the `+/-` symbols prepended in the property to order by. For example, if you want invitations to be returned in descending order according to their `created_at` property, you can use `-created_at`. If you don't use `+` or `-`, then `+` is implied. Defaults to `-created_at`.
Default:-created_at
paginatedbooleanoptional
Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
limitintegeroptional
Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
Default:10
offsetintegeroptional
Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
Default:0

1 status code
200List of invitations
objectstringrequired
Allowed:invitation
idstringrequired
email_addressstringrequired
public_metadataobjectrequired
revokedbooleanoptional
statusstringrequired
Allowed:pendingacceptedrevokedexpired
urlstringoptional
expires_atintegeroptional
Unix timestamp of expiration.
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.