List invitations

Lists the workspace's invitations, newest first. Filter by status to separate pending invitations from accepted or expired ones.

Requires the admin role on the workspace.

Authorization

AuthorizationBearer <token>

An OpenID Connect access token issued by Keycloak, acting as the signed-in user.

In: header

Path Parameters

workspaceId*string

Query Parameters

cursor?string

The nextCursor of the previous page. Omit it to start from the beginning. A cursor encodes a position and is not meant to be built by hand.

limit*|

How many items to return, from 1 to 200.

Range1 <= value <= 200

Default50

q?string

Match part of the invited email address.

Lengthlength <= 255

status?||

Only return invitations in this state.

Response Body

`application/json`

curl -X GET "https://api-next.centralcsp.com/v1/workspaces/string/invitations?limit=50"

{  "data": [    {      "id": "string",      "workspaceId": "string",      "email": "sam@example.com",      "role": "admin",      "acceptedAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true,    "total": 0  }}