CentralCSP
APIInvitations

Get an invitation

Returns one invitation with its email, role, and expiry.

Requires the admin role on the workspace.

GET
/v1/workspaces/{workspaceId}/invitations/{invitationId}

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

invitationId*string

The invitation's id.

Response Body

An invitation to join a workspace.

application/json
  1. response
id*string

Unique identifier of the invitation.

workspaceId*string

The workspace's id.

email*string

Address the invitation was sent to.

Formatemail
role*MemberRole

member is a regular collaborator. admin can also administer the workspace, its members, and its websites.

Value in"admin""member"
acceptedAt*|

When it was accepted, or null while it is still pending.

expiresAt*|

After this time the link no longer works.

createdAt*string

When the invitation was sent.

Formatdate-time
updatedAt*string

When the invitation last changed.

Formatdate-time
Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/invitations/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90'
Example Response
{  "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"}