List of contracts | Deel

Retrieve a list of contracts. Token scopes: contracts: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.

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

Learn more about authentication

## 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)

AuthorizationBearer

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

Query parameters

after_cursorstringOptional

Return next page of results after the given cursor.

limitstringOptionalformat: "^[0-9]+$"

Return a page of results with the given number of records.

order_directionenumOptional

Order direction of results; ascending or descending.

Allowed values:

typeslist of enumsOptional

Filter contracts by type. A contract is included in the results if its type is in this list.

statuseslist of enumsOptional

Filter contracts by current status. A contract is included in the results if its status is in this list.

team_idstringOptional

Filter contracts for the given team ID. NOTE: All query parameters are technically strings or arrays of strings.

external_idstringOptional

Filter contracts for the given external ID.

external_id_absentstringOptional

Filter contracts by external ID presence. When true, returns contracts without an external ID. When false, returns contracts with an external ID. Cannot be used with external_id query param when set to true.

countrieslist of stringsOptional

Filter contracts by country codes.

currencieslist of strings or stringOptional

Filter contracts by currency codes.

searchstringOptional

Include a contract if its name or the contractor's name contains the given search term.

sort_byenumOptional

Sort contracts by the given field name.

Allowed values:

expandenumOptional

Include cost centers in the response.

Allowed values:

Response

Successful operation.

datalist of objects

Array of contract objects.

pageobject

Pagination information for the response.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -G https://api.letsdeel.com/rest/v2/contracts \
2	-H "Authorization: Bearer <token>" \
3	-d after_cursor=eyJlZmZlY3RpdmVEYXRlIjoiMjAyMy0wNS0wMyIsImlkIjozOSwibGltaXQiOjMsInJhbmsiOjZ9 \
4	-d limit=50 \
5	-d order_direction=desc \
6	-d types=ongoing_time_based \
7	-d types=milestones \
8	-d types=pay_as_you_go_time_based \
9	-d statuses=waiting_for_client_sign \
10	-d statuses=waiting_for_contractor_sign \
11	-d team_id=123e4567-e89b-12d3-a456-426614174000 \
12	-d external_id=1234567890 \
13	-d external_id_absent=true \
14	-d countries=US \
15	-d countries=GB \
16	-d currencies=USD \
17	-d currencies=GBP \
18	-d search=Test \
19	-d sort_by=contract_title \
20	-d expand=cost_centers

1	{
2	"data": [
3	{
4	"id": "d0377f58-f152-413a-aa9f-997bdfc61fc2",
5	"type": "ongoing_time_based",
6	"title": "Ken",
7	"client": {
8	"team": {
9	"id": "d0377f58-f152-413a-aa9f-997bdfc61fc2",
10	"name": "Ken"
11	}
12	},
13	"status": "waiting_for_client_sign",
14	"created_at": "2019-03-21T13:45:07.515Z",
15	"signatures": {
16	"client_signed_at": "2019-03-21T13:45:07.515Z",
17	"worker_signature": "John Doe",
18	"worker_signed_at": "2019-03-21T13:45:07.515Z"
19	},
20	"invitations": {
21	"client_email": "test@example.com",
22	"worker_email": "test@example.com"
23	},
24	"is_archived": false,
25	"is_shielded": false,
26	"termination_date": "2022-10-21T09:33:12.256Z"
27	}
28	],
29	"page": {
30	"cursor": "eyJ0eXBlIjoiY29udGV4dCIsInN0YXR1cyI6Im5ldyJ9",
31	"total_rows": 100
32	}
33	}

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