Skip to navigation

List payroll groups for a legal entity

Lists the active payroll groups of a legal entity, with the REGULAR payroll calendars of each group that start in the chosen year (the current year by default). Use it to find the payroll groups of a legal entity and their calendars for a given year; leave the calendars out when you only need the groups.

Token scopes: global-payroll:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

legalEntityIdstringRequiredformat: "uuid"
Public UUID of the legal entity whose payroll groups to retrieve.
calendarYearintegerOptional2020-2035
Calendar year to filter payroll cycles by. Defaults to the current year.
includePayrollCalendarbooleanOptionalDefaults to true
Whether to include REGULAR payroll calendars for each group. Defaults to true. Set to false to skip calendar fetching for a faster response.
paginationobjectOptionalDefaults to {"limit":10}

Cursor-based pagination parameters. limit: max items per page (1-15, default 10). cursor: opaque string from the previous response’s pagination.nextCursor field.

Response

OK
datalist of objects
paginationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error