List payroll cycles | Deel

Use this endpoint to retrieve a list of payroll events for a specified legal entity. Token scopes: legal-entity:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

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

Path parameters

legal_entity_idstringRequiredformat: "uuid"

The unique identifier (public ID) for the legal entity.

Query parameters

date_startstringOptionalformat: "date"

Start date in the format ‘YYYY-MM-DD’. Must not be earlier than 5 years ago.

date_endstringOptionalformat: "date"

End date in the format ‘YYYY-MM-DD’. Must not exceed 5 years in the future.

limitintegerOptional1-100Defaults to 20

Maximum number of items to return.

cursorstringOptional

Pagination cursor, CUID or UUID format.

Response

Successful operation.

datalist of objects

has_moreboolean

Indicates whether more pages are available.

items_per_pageinteger

The number of items per page.

next_cursorstring or null

Pagination cursor to fetch the next page of results.

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/legal-entities/05ae50dc-3540-4f9a-a395-3486d2b81a4d/payroll-events"
4
5	querystring = {"date_start":"2021-01-01","date_end":"2022-01-01","limit":"20","cursor":"abcdefghijklmnopqrstuvwx"}
6
7	headers = {"Authorization": "Bearer <token>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"data": [
3	{
4	"id": "05ae50dc-3540-4f9a-a395-3486d2b81a4d",
5	"type": "REGULAR",
6	"date_end": "2023-01-15T00:00:00.000Z",
7	"date_start": "2023-01-01T00:00:00.000Z",
8	"legal_entity_id": "05ae50dc-3540-4f9a-a395-3486d2b81a4d",
9	"payroll_group_id": "payroll_group_67890"
10	}
11	],
12	"has_more": true,
13	"items_per_page": 5,
14	"next_cursor": "next_cursor_abcdefg"
15	}

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication