Skip to main content
GET
Get a direct assessment link
Use this when you want to deliver the assessment yourself, such as embedding the link in your own onboarding email, a chat message, or a QR code. Nothing is sent to the individual when you call it.
Unlike the email and SMS invites, this URL is not a one-time magic link and does not expire. Opening it does not sign the individual in. They are shown a masked version of the email address or phone number on their profile and must request a one-time sign-in link to that contact before starting, so sharing the URL exposes no profile data.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

profileId
string
required

ID of the profile to get the assessment link for.

Response

Success

Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.

code
integer<int32>
required

HTTP status code of the successful response.

The URL the individual opens to take their assessment.

status
enum<string>

Always "success" for successful responses.

Available options:
success