APIInvitations
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.
GET
header
AuthorizationBearer <JWT>An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.
workspaceId*stringThe workspace's id.
cursor?stringThe 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.
Range
1 <= value <= 200Default
50q?stringMatch part of the invited email address.
Length
length <= 255status?stringOnly return invitations in this state.
Value in
"pending""accepted""expired"A page of invitations.
application/json- response
data*array<>The invitations on this page.
pagination*Where this page sits in the full result set.
Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/invitations?limit=50'Example Response
{ "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 }}