Skip to main content
GET
/
api
/
invitations
List invitations
curl --request GET \
  --url https://api.example.com/api/invitations \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "expiresAt": "<string>",
      "createdAt": "<string>",
      "acceptedAt": "<string>",
      "status": "pending",
      "createdBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "firstName": "<string>",
        "lastName": "<string>",
        "type": "invited",
        "status": "active"
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "firstName": "<string>",
        "lastName": "<string>",
        "type": "invited",
        "status": "active"
      },
      "organisation": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "paginate": {
    "current": 123,
    "from": 123,
    "to": 123,
    "total": 123,
    "pageSize": 123
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Query Parameters

Search term to filter invitations by email

status
enum<string>

Filter invitations by status

Available options:
pending,
accepted
page
number
default:1

Current page

perPage
number
default:10

Number of items per page

Response

200 - application/json

Paginated list of invitations

Paginated list of invitations

results
object[]
required

List of invitations

paginate
object
required

Pagination metadata