Get an assessment package

GET/assessment/{connection_id}/package/{id}

Parameters

connection_idstring required

ID of the connection

idstring required

ID of the Package

Returns

Response field	Type	Required	Description
`id`	string	No	Unique identifier for the assessment package
`created_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`workspace_id`	string	No	Workspace ID that this package belongs to (reference to KmsSpace) (read-only)
`connection_id`	string	No	Connection ID that this package belongs to (read-only)
`integration_types`	string[]	No	Integration types that support this package
`name`	string	No	Name of the assessment package
`type`	enum	Yes	Values: `SKILLS_TEST`, `BEHAVIORAL_ASSESSMENT`, `VIDEO_INTERVIEW`, `BACKGROUND_CHECK`, `REFERENCE_CHECK`, `OTHER`
`aliases`	string[]	No	Alternative namesidentifiers for this package
`tags`	string[]	No	Category tags (e.g., "Assessment", "Background Check")
`description`	string	No	Detailed description
`parameters`	AssessmentParameter[]	No	Questionsinputs needed for this assessment (aligned with verification)
`parameters[].id`	string	No
`parameters[].name`	string	No
`parameters[].public_question`	string	No	Question to ask the candidateuser
`parameters[].type`	enum	No	Values: `TEXT`, `NUMBER`, `MULTIPLE_CHOICE`, `MULTIPLE_SELECT`, `DATE`, `FILE`
`parameters[].options`	string[]	No	Options for MULTIPLE_CHOICE and MULTIPLE_SELECT
`parameters[].file_types`	string[]	No	Valid file MIME types for FILE type
`parameters[].valid_regions`	string[]	No	Regions where this parameter is valid ({country}-{state} or {country})
`parameters[].is_required`	boolean	No
`has_redirect_url`	boolean	No	Whether provider redirects user to complete assessment
`has_target_url`	boolean	No	Where provider redirects user after completion
`needs_ip_address`	boolean	No	Whether IP address is required
`max_score`	number	No	Maximum possible score if this assessment returns a score
`info_url`	string	No	URL to find additional information about this package
`regions`	AssessmentPackageRegion[]	No
`regions[].regions`	string[]	No	Countryregion codes where this package is available ({country}-{state} or {country})
`regions[].cost_amount`	number	No
`regions[].currency`	string	No	ISO 4217 format
`regions[].processing_time`	number	No	Processing time in milliseconds

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"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not 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/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },

};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.assessment.getAssessmentPackage({ connectionId, id, 

 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/assessment/5de520f96e439b002043d8dc/package/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },

};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/assessment/5de520f96e439b002043d8dc/package/5de520f96e439b002043d8d8")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/assessment/5de520f96e439b002043d8dc/package/5de520f96e439b002043d8d8

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/assessment/5de520f96e439b002043d8dc/package/5de520f96e439b002043d8d8"

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/assessment/5de520f96e439b002043d8dc/package/5de520f96e439b002043d8d8",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/assessment/5de520f96e439b002043d8dc/package/5de520f96e439b002043d8d8")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/assessment/5de520f96e439b002043d8dc/package/5de520f96e439b002043d8d8' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?