Skip to main content
GET
/
invites
List assessment invites
curl --request GET \
  --url http://localhost:3000/api/v1/invites \
  --header 'x-api-key: <api-key>'
{
  "invites": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assessmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assessmentName": "<string>",
      "recipientEmail": "[email protected]",
      "recipientName": "<string>",
      "status": "pending",
      "questionReplayLimit": 123,
      "answerRecordLimit": 123,
      "sentAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "acceptedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Format: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Query Parameters

​
assessmentId
string<uuid>

Filter invites by assessment ID

​
status
enum<string>

Filter invites by status

Available options:
pending,
accepted,
started,
completed,
expired,
revoked

Response

Successful response

​
invites
object[]