Clarify API
Invitations

List invitations

Returns the workspace’s invitations and their states as a JSON:API list with `links` and `meta`, in one page.

GET
/workspaces/{workspace}/invitations

Authorization

apiKey
Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

Response Body

application/json

curl -X GET "https://example.com/workspaces/string/invitations"
{  "links": {    "next": null,    "prev": null  },  "meta": {    "total_records": 1,    "total_pages": 1,    "offset": 0,    "limit": 500  },  "data": [    {      "type": "invitation",      "id": "invitation_01HXYZACMEJANEDOE00000000",      "attributes": {        "id": "invitation_01HXYZACMEJANEDOE00000000",        "invitee_email": "jane@acme.com",        "status": "pending"      }    }  ]}

Invite a user

Emails an invitation to join the workspace and returns the outcome as a JSON:API resource. Inviting someone with a pending invitation resends it, and inviting an existing member sends nothing and returns a `null` id.

Resend an invitation

Sends the invitation email again for a pending invitation.