Retrieve an order

Updated:

GET/assessment/{connection_id}/order/{id}

Retrieves a single AssessmentOrder by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Order

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstringYesWorkspace ID that this order belongs to (reference to KmsSpace)
connection_idstringYesConnection ID that this order belongs to
webhook_idstringNoWebhook ID that this order belongs to
package_idstringNoAssessment package ID
parametersAssessmentParameterInput[]NoFilled-in answers to the package's parameter questions
parameters[].parameter_idstringNo
parameters[].namestringNoName of parameter
parameters[].inputsstring[]No
target_urlstringNoURL to redirect user to after assessment
statusenumNoThe current state of the assessment order Values: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED
referencestringNoATS-specific reference ID
application_idstringNoATS application ID
job_idstringNoATS job ID
company_idstringNoATS company ID (reference to AtsCompany)
candidate_idstringNoATS candidate ID
employee_idstringNoATS employee ID
profile_namestringNo
profile_first_namestringNo
profile_last_namestringNo
profile_resume_urlstringNo
profile_ip_addressstringNoXXX.XXX.XXX.XXX
profile_date_of_birthstringNoYYYY-MM-DD
profile_addressesAssessmentAddress[]No
profile_addresses[].address1stringNo
profile_addresses[].address2stringNo
profile_addresses[].citystringNo
profile_addresses[].regionstringNoRegional area (e.g., state in the U.S., province in Canada)
profile_addresses[].region_codestringNoShort form for regional area (e.g., two-letter stateprovince abbreviation)
profile_addresses[].postal_codestringNo
profile_addresses[].countrystringNo
profile_addresses[].country_codestringNoCountry code in ISO 3166 A-2 format
profile_genderenumNoValues: MALE, FEMALE, INTERSEX, TRANS, NON_BINARY
profile_emailsstring[]No
profile_telephonesstring[]No
profile_national_identifierstringNo
profile_social_media_urlsstring[]No
response_completed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_expires_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_issued_atstring (date-time)NoDatetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_statusenumNoValues: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED
response_scorenumberNoAssessment score (e.g., 0-100)
response_max_scorenumberNoMaximum possible score
response_urlstringNoURL to view detailed results
response_redirect_urlstringNoURL to redirect the user to complete assessment
response_download_urlsstring[]NoReport download URLs
response_detailsAssessmentResponseDetail[]No
response_details[].titlestringNo
response_details[].textstringNo
response_details[].is_privatebooleanNo
response_details[].is_failed_reasonbooleanNo
response_details[].parameter_idstringNoIn reference to the parameter input
response_details[].download_urlstringNo
response_sourcestringNo
response_attributesAssessmentAttribute[]NoAdditional result attributes
response_attributes[].typeenumYesValues: TEXT, NUMBER, SUB_RESULT
response_attributes[].labelstringYes
response_attributes[].valuestringNoFor TEXT and NUMBER types
response_attributes[].referencestringNoFor SUB_RESULT type
response_attributes[].score_valuenumberNo
response_attributes[].score_maxnumberNo
response_attributes[].statusenumNoFor SUB_RESULT type Values: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED
metadataAssessmentMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.
metadata[].valueobjectNoThe field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

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/order/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

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