Get test link
Issues a per-taker one-time magic link for use in embedded test-taker flows. Each call rotates the token - prior links are immediately invalidated. The link is valid for 24 hours from issuance. Optional redirectUri and referenceId are appended as query parameters (redirect_uri and reference_id) to the returned URL. May briefly return 409 (test_taker_not_provisioned) right after creating a test taker - retry after the Retry-After header. The server sends a jittered Retry-After in the 1–5 second window so concurrent CSV-import retries do not synchronize on a 1-second boundary against the scheduler. Clients SHOULD additionally apply their own exponential backoff on repeated 409s - recommended schedule 1s → 2s → 4s capped at 4s.
For how redirectUri and referenceId work end to end — including the Redirect URI allowlist that gates the return redirect, and how results are matched back to your system — see Linking with the Impirica Platform.
Authorizations
API key generated in the Portal (Workspace Settings → API Keys).
Path Parameters
Project Id. Obtain via GET /projects or from the project URL.
The unique identifier of the test taker (ProjectEntry.Id).
Body
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. See Redirect URIs.
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