Step 1 of a UKG Ready setup involves obtaining all of the necessary credentials from the UKG consultant.
Ask the UKG Ready consultant to provide:
API Username (Account ID)
Company Short Name (Company ID)
API Password
System ID (Report ID)
Base Link (e.g.,
secure4.saashr.com)Module: “Applicant” or “Employee”
API Key
Custom Field Indexes: Report, Status, Message, Package
Understanding Custom Field Indexes
The consultant should provide the Custom Field system index (e.g., "Extra Field 1"), but please note:
UKG system indexes start at 1
API indexes start at 0
(e.g.) If the consultant says "Custom Field Value 1," you will enter 0 into Integration Manager. If you prefer to confirm values directly, see the API method below.
Optional: Use API to Retrieve Field Indexes You can retrieve the correct API indexes by running the following API calls in Postman or your preferred API tool:
Step 1: Get Bearer Token
curl --location 'https://secure4.saashr.com/ta/rest/v1/login' \
--header 'Content-Type: application/json' \
--header 'Api-Key: [API_KEY]' \
--data-raw '{
"credentials": {
"username": "[API_USERNAME]",
"password": "[API_PASSWORD]",
"company": "[COMPANY_ID]"
}
}'
This returns a Bearer Token in the response, which you will use to authenticate your next two GET requests.
A. If Using Applicant Module
Step 2: Pull the Saved Report
curl --location 'https://secure3.saashr.com/ta/rest/v1/report/saved/[REPORT_ID]' \
--header 'Authentication: Bearer [BEARER_TOKEN]' \
--header 'Accept: application/xml'
This lists applicants tied to the saved report. Use an Applicant ID from the response for the next step.
Step 3: Get the Applicant’s Custom Fields
curl --location 'https://secure3.saashr.com/ta/rest/v2/companies/[COMPANY_ID]/applicants/[APPLICANT_ID]' \
--header 'Authentication: Bearer [BEARER_TOKEN]' \
--header 'Accept: application/json'
Look for the "applicant_custom_fields" section in the response.
Plug these values into IM as the Report/Status/Message/Package Custom Field Index values.
B. If Using Employee Module
Step 2: Pull the Saved Report
curl --location 'https://secure3.saashr.com/ta/rest/v1/report/saved/[REPORT_ID]' \
--header 'Authentication: Bearer [BEARER_TOKEN]' \
--header 'Accept: application/xml'
Step 3: Get the Employee’s Custom Fields
curl --location 'https://secure4.saashr.com/ta/rest/v2/companies/[COMPANY_ID]/employees/[EMPLOYEE_ID]' \
--header 'Authentication: Bearer [BEARER_TOKEN]' \
--header 'Accept: application/json'
Look for the "account_extra_fields" section in the response.
Plug these values into IM as the Report/Status/Message/Package Custom Field Index values.