List pending invites

Returns unused user invites that have not been accepted yet. Includes email invites and shareable link invites.

get/users/pending-invites

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/users/pending-invites
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: users:read

Response

A list of pending invites

idinteger

The invite ID.

emailstring

The invited email address. Empty for shareable link invites.

typestring

The invite type. Can be 'email' or 'link'.

rolestring

The role assigned when the invite is accepted. Can be 'admin' or 'default'.

invited_atinteger

Unix timestamp indicating when the invite was created.

expires_atinteger

Unix timestamp indicating when the invite expires.

Example response

[
  {
    "id": 12,
    "email": "wendysnutz@gmail.com",
    "type": "email",
    "role": "default",
    "invited_at": 1720059659,
    "expires_at": 1721269259
  }
]

Changes

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