Get Invite - AlfaOne API

Get invite details

curl --request GET \
  --url https://api.alfaone.com/api/v1/invites/{inviteId} \
  --header 'x-api-key: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessmentName": "<string>",
  "recipientEmail": "jsmith@example.com",
  "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",
  "assignedGrader": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com"
  },
  "proctoringSettings": {
    "screenRecording": true,
    "webcamMonitoring": true,
    "requireIdCapture": true
  },
  "customMessage": "<string>",
  "revokedAt": "2023-11-07T05:31:56Z"
}

GET

/

invites

/

{inviteId}

Get invite details

curl --request GET \
  --url https://api.alfaone.com/api/v1/invites/{inviteId} \
  --header 'x-api-key: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessmentName": "<string>",
  "recipientEmail": "jsmith@example.com",
  "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",
  "assignedGrader": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com"
  },
  "proctoringSettings": {
    "screenRecording": true,
    "webcamMonitoring": true,
    "requireIdCapture": true
  },
  "customMessage": "<string>",
  "revokedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key

string

header

required

API key for authentication. Format: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Path Parameters

inviteId

string<uuid>

required

Unique identifier of the invite

Response

Successful response

id

string<uuid>

Unique identifier of the invite

assessmentId

string<uuid>

ID of the assessment

assessmentName

string

Name of the assessment

recipientEmail

string<email>

Email address of the invited candidate

recipientName

string | null

Name of the invited candidate

status

enum<string>

Current status of the invite

Available options:

pending,

accepted,

started,

completed,

expired,

revoked

questionReplayLimit

integer

Maximum number of times a candidate can replay each question

answerRecordLimit

integer

Maximum number of recording attempts per answer

sentAt

string<date-time>

When the invite was sent

expiresAt

string<date-time>

When the invite expires

acceptedAt

string<date-time> | null

When the invite was accepted

startedAt

string<date-time> | null

When the candidate started the assessment

completedAt

string<date-time> | null

When the candidate completed the assessment

assignedGrader

object

Grader assigned to review this candidate's submission

Show child attributes

proctoringSettings

object

Proctoring configuration for this invite

Show child attributes

customMessage

string | null

Custom message included with the invite

revokedAt

string<date-time> | null

When the invite was revoked (if applicable)