Skip to navigation
API ReferencePayroll

List Incentive Types

Returns the incentive types (incentive heads) your company set up, oldest first. Deleted ones are left out. Requires Payroll Pro.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 50.

Response

Incentive types, oldest first.
datalist of objects
messagestringOptional
statusbooleanOptional
countintegerOptional
Total number of results across all pages.
prevstring or nullOptional
URL of the previous page, or null.
nextstring or nullOptional
URL of the next page, or null.

Errors

403
Forbidden Error