List all payrolls

GET/hris/{connection_id}/payroll

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
user_idstring
The user/employee ID to filter by (reference to HrisEmployee)
company_idstring
The company ID to filter by (reference to HrisCompany)
group_idstring
The group ID to filter by (reference to HrisGroup)
type enum
start_gtestring
The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_ltstring
The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
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

Returns

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
company_idstring
(reference to HrisCompany)
group_idstring
the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)
status enum
Valid values:
"DRAFT"
"PENDING"
"APPROVED"
"PROCESSING"
"PAID"
type enum
Valid values:
"REGULAR"
"OFF_CYCLE"
"BONUS"
"CORRECTION"
"TERMINATION"
start_atdate-time
pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
paid_atdate-time
pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
approved_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
currencystring
gross_amountnumber
net_amountnumber
employee_tax_amountnumber
employer_tax_amountnumber
deduction_amountnumber
total employee deductions
employer_contribution_amountnumber
total employer benefit contributions
total_cost_amountnumber
total company cost/debit for this payroll
user_idsstring array
employees paid in this payroll
payslip_idsstring 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/hris/5de520f96e439b002043d8dc/payroll',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-08T17:46:46.364Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    user_id: '',
    company_id: '',
    group_id: '',
    type: '',
    start_gte: '',
    end_lt: '',
    fields: '',
    raw: '',
  }
};

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