> This page is for API, version 2026-01-01 (Stable) (default). > For other versions, use one of these documentation indexes: > - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.deel.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server. # List payroll groups for a legal entity GET https://api.letsdeel.com/rest/payroll-groups Returns payroll groups and their associated REGULAR calendars for the specified legal entity. Defaults to the current year; pass `calendarYear` to retrieve a specific year. **Token scopes**: `global-payroll:read` Reference: https://developer.deel.com/api/reference/endpoints/global-payroll/list-payroll-groups-v-2026-09-08 ## Authentication - `Authorization` header (bearer token, required) — ## 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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) - `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/ ## Servers - `https://api.letsdeel.com/rest` (Production, default) - `https://api-staging.letsdeel.com/rest` (Demo) ## Request ### Query parameters - `legalEntityId` (string, required) — Public UUID of the legal entity whose payroll groups to retrieve. - `calendarYear` (integer, optional) — Calendar year to filter payroll cycles by. Defaults to the current year. - `includePayrollCalendar` (boolean, optional, default: true) — Whether to include REGULAR payroll calendars for each group. Defaults to true. Set to false to skip calendar fetching for a faster response. - `pagination` (PayrollGroupsGetParametersPagination, optional, default: {"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 ### 200 OK - `data` (list of PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItems, required) - `pagination` (PayrollGroupsGetResponsesContentApplicationJsonSchemaPagination, required) ## Errors ### 400 Bad Request Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ### 401 Unauthorized Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ### 403 Forbidden Error 403 - `code` (string, required) - `status` (double, required) - `defined` (boolean, required) - `message` (string, required, default: The caller is not authorized to access this legal entity.) - `data` (any, optional) ### 404 Not Found Error 404 - `code` (string, required) - `status` (double, required) - `defined` (boolean, required) - `message` (string, required, default: Legal entity not found.) - `data` (any, optional) ### 500 Internal Server Error 500 - `code` (string, required) - `status` (double, required) - `defined` (boolean, required) - `message` (string, required, default: Unable to retrieve payroll groups from upstream.) - `data` (any, optional) ## Types ### PayrollGroupsGetParametersPagination - `limit` (integer, optional, default: 10) - `cursor` (string, optional) ### PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItems - `id` (string, required) — Unique identifier of the payroll group. - `name` (string, required) — Human-readable name of the payroll group. - `calendars` (list of PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItems, required) — REGULAR calendars for this group within the requested year. - `is_active` (boolean, required) — Whether the payroll group is currently active. - `regular_cycle_cadence` (enum, required) — Frequency at which regular payroll cycles are run for this group. - Allowed values: `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `BIMONTHLY`, `FOUR_WEEKLY`, `QUARTERLY` ### PayrollGroupsGetResponsesContentApplicationJsonSchemaPagination - `limit` (integer, required) — Maximum number of items returned in this page. - `hasMore` (boolean, required) — Whether additional pages exist after this one. - `nextCursor` (string, required, nullable) — Opaque cursor for the next page, or null when there are no more results. ### ApiErrorRequest - `method` (string, optional) — The HTTP method of the failed request - `url` (string, optional) — The relative URL of the failed request - `status` (double, optional) — The status code of the response - `api_req_id` (string, optional) — The request ID of the failed request - `docs` (string, optional) — A link to the official documentation for the requested endpoint resource - `source` (string, optional) — The source handler which produced the returned error - `code` (double, optional) — The code of the source handler which produced the returned error ### ApiError - `message` (string, optional) — A description of the returned error - `path` (string, optional) — The JSON path where input validation failed ### PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItems - `id` (string, required) — Unique identifier of the calendar. - `values` (map from string to PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItemsValues, required) — Map of calendar event keys (e.g. START, SALARY_PAY) to their scheduled date-time values. - `calendar_type` (string, required) — Type of the calendar, e.g. REGULAR. ### PayrollGroupsGetResponsesContentApplicationJsonSchemaDataItemsCalendarsItemsValues - `value` (string, required) — ISO-8601 date-time value for this calendar key. ## Examples **Response** ```json { "data": [ { "id": "019ed109-aff0-777c-a0bc-b24e9f5eb6df", "name": "Monthly Payroll", "calendars": [ { "id": "019ed109-b234-777c-a0bd-54060d27425a", "values": { "SALARY_PAY": { "value": "2026-01-31T00:00:00.000Z" }, "START": { "value": "2026-01-01T00:00:00.000Z" } }, "calendar_type": "REGULAR" } ], "is_active": true, "regular_cycle_cadence": "MONTHLY" } ], "pagination": { "limit": 10, "hasMore": false, "nextCursor": "Mg==" } } ``` **SDK Code** ```python import requests url = "https://api.letsdeel.com/rest/payroll-groups" querystring = {"calendarYear":"2026","includePayrollCalendar":"true","legalEntityId":"3fe30c6d-e07a-471e-ac9d-9b5e03a78925","pagination":"{\"limit\":10}"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/payroll-groups?calendarYear=2026&includePayrollCalendar=true&legalEntityId=3fe30c6d-e07a-471e-ac9d-9b5e03a78925&pagination=%7B%22limit%22%3A10%7D'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/payroll-groups?calendarYear=2026&includePayrollCalendar=true&legalEntityId=3fe30c6d-e07a-471e-ac9d-9b5e03a78925&pagination=%7B%22limit%22%3A10%7D" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.letsdeel.com/rest/payroll-groups?calendarYear=2026&includePayrollCalendar=true&legalEntityId=3fe30c6d-e07a-471e-ac9d-9b5e03a78925&pagination=%7B%22limit%22%3A10%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.letsdeel.com/rest/payroll-groups?calendarYear=2026&includePayrollCalendar=true&legalEntityId=3fe30c6d-e07a-471e-ac9d-9b5e03a78925&pagination=%7B%22limit%22%3A10%7D") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.letsdeel.com/rest/payroll-groups?calendarYear=2026&includePayrollCalendar=true&legalEntityId=3fe30c6d-e07a-471e-ac9d-9b5e03a78925&pagination=%7B%22limit%22%3A10%7D', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/payroll-groups?calendarYear=2026&includePayrollCalendar=true&legalEntityId=3fe30c6d-e07a-471e-ac9d-9b5e03a78925&pagination=%7B%22limit%22%3A10%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/payroll-groups?calendarYear=2026&includePayrollCalendar=true&legalEntityId=3fe30c6d-e07a-471e-ac9d-9b5e03a78925&pagination=%7B%22limit%22%3A10%7D")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```