Skip to main content
POST
Get test link

Authorizations

x-api-key
string
header
required

API key generated in the Portal (Workspace Settings → API Keys).

Path Parameters

projectId
string<uuid>
required

Project Id. Obtain via GET /projects or from the project URL.

id
integer<int32>
required

The unique identifier of the test taker (ProjectEntry.Id).

Body

redirectUri
null | string

Optional. A URL the test taker's browser is sent to after they complete the assessment, appended to the magic link as redirect_uri. The redirect only fires if this URL matches the workspace's Redirect URI allowlist, and no result data is ever appended to it. When the link is opened inside the embedded SDK shell the redirect never fires; the shell returns control to the host app instead. See Redirect URIs.

referenceId
null | string

Optional. Your own identifier for this test taker (for example an employee number or subject ID), appended to the magic link as reference_id. It is returned alongside the result so you can match it back to your record. Max 500 characters; letters, numbers, and _ - . + @. See Reference IDs.

Response

OK

url
string
required

One-time magic-link URL for the test taker's session. Valid for a single use and rotates on each call — prior links are immediately invalidated.

expiresAtUtc
string
required

Valid until the test taker starts the assessment or the 24-hour window elapses, whichever comes first (ISO-8601, UTC). Still rotates on each call — prior links are immediately invalidated.