Skip to main content
GET
List assessment invites

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