Skip to main content
GET
/
invites
List assessment invites
curl --request GET \
  --url https://alfaone.app/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": "jsmith@example.com",
      "recipientName": "<string>",
      "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"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 87,
    "totalPages": 5
  }
}

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
​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
limit
integer
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100
​
sort
enum<string>
default:sent_at

Field to sort by

Available options:
sent_at,
status,
expires_at
​
order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

Successful response

​
invites
object[]
​
pagination
object