List assessment packages

Updated:

GET/assessment/{connection_id}/package

Parameters

limitnumber default=100
offsetnumber default=0
connection_idstring required
ID of the connection

Returns

Used by assessment providers to SUBMIT packages to ATS systems

idstring
Unique identifier for the assessment package
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstring read-only
Workspace ID that this package belongs to (reference to KmsSpace)
connection_idstring read-only
Connection ID that this package belongs to
integration_typesstring array
Integration types that support this package
namestring
Name of the assessment package
type enum required
Valid values:
"SKILLS_TEST"
"BEHAVIORAL_ASSESSMENT"
"VIDEO_INTERVIEW"
"BACKGROUND_CHECK"
"REFERENCE_CHECK"
aliasesstring array
Alternative namesidentifiers for this package
tagsstring array
Category tags (e.g., "Assessment", "Background Check")
descriptionstring
Detailed description
parameters array
Questionsinputs needed for this assessment (aligned with verification)
has_redirect_urlboolean
Whether provider redirects user to complete assessment
has_target_urlboolean
Where provider redirects user after completion
needs_ip_addressboolean
Whether IP address is required
max_scorenumber
Maximum possible score if this assessment returns a score
info_urlstring
URL to find additional information about this package
regions array
metadata array

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/assessment/5de520f96e439b002043d8dc/package',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?