curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/pay_schedules \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "pay_schedule",
"data": {
"business_entity": {
"id": "<id>",
"object": "business_entity",
"links": {
"self": "/business_entities/<id>"
}
},
"title": "Default Schedule",
"pay_frequency": "monthly",
"anchor_pay_date": "2026-01-31",
"anchor_start_of_pay_period": "2026-01-01",
"anchor_end_of_pay_period": "2026-01-31",
"generate_payrolls_from": null,
"day_1": -1,
"day_2": null,
"pay_day_movement_setting": "inherit",
"send_empty_pay_stubs": true,
"pay_stub_settings": {
"show_vacation_pay_balance": false
},
"custom_pay_periods_per_year": null,
"is_editable": true,
"is_deletable": true,
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/pay_schedules/<id>"
}
}
],
"links": {
"first": "/pay_schedules?business_entity_id=<id>&page=1",
"last": "/pay_schedules?business_entity_id=<id>&page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 1,
"has_more": false
}
}List pay schedules
curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/pay_schedules \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "pay_schedule",
"data": {
"business_entity": {
"id": "<id>",
"object": "business_entity",
"links": {
"self": "/business_entities/<id>"
}
},
"title": "Default Schedule",
"pay_frequency": "monthly",
"anchor_pay_date": "2026-01-31",
"anchor_start_of_pay_period": "2026-01-01",
"anchor_end_of_pay_period": "2026-01-31",
"generate_payrolls_from": null,
"day_1": -1,
"day_2": null,
"pay_day_movement_setting": "inherit",
"send_empty_pay_stubs": true,
"pay_stub_settings": {
"show_vacation_pay_balance": false
},
"custom_pay_periods_per_year": null,
"is_editable": true,
"is_deletable": true,
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/pay_schedules/<id>"
}
}
],
"links": {
"first": "/pay_schedules?business_entity_id=<id>&page=1",
"last": "/pay_schedules?business_entity_id=<id>&page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 1,
"has_more": false
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
business_entity, payrolls Response
OK
The type of the object in Nmbr ("list").
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("pay_schedule").
- Default
- With business_entity expanded
- With payrolls expanded
Hide child attributes
Hide child attributes
255The frequency at which Payrolls are processed. Use custom for non-standard schedules where the number of pay periods per year is specified manually.
bi-weekly, custom, monthly, semi-monthly, weekly The pay date of the anchor pay period. Together with anchor_end_of_pay_period, this establishes the pattern from which all future pay dates are calculated.
The start date of the anchor pay period. Only required for semi-monthly pay schedules when anchor_end_of_pay_period is not the 15th or the last day of the month. For standard configurations it is derived automatically and does not need to be supplied.
The end date of the anchor pay period. Together with anchor_pay_date, this defines the length and pattern of all future pay periods.
Only available in preview mode. When set, Payrolls are generated starting from this date rather than the default, allowing historical Payrolls to be created before the current date.
For monthly pay schedules, the day of the month on which pay is issued. For semi-monthly pay schedules, the first of two pay days per month.
For semi-monthly pay schedules, the second of two pay days per month.
The pay schedule-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to inherit, the Business Entity's setting is used.
inherit, next_business_day, previous_business_day Whether Pay Stubs are generated for employees with no earnings in a given pay period.
When pay_frequency is custom, the number of pay periods per year.
Whether the pay schedule's configuration can be edited. A pay schedule becomes non-editable once any of its Payrolls have been approved or paid. When false, only the title field may be updated.
Whether the pay schedule can be deleted. A pay schedule may not be deleted once any of its Payrolls have been approved or paid. In preview mode, any pay schedule may be deleted.
A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.
255The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.