Skip to navigation
EndpointsIt Agreements

List agreements

Beta

Lists the rental agreements your organization holds with Deel, each with its current store-and-reuse state. Call this to find agreements whose device is free to hand to a different worker — an agreement in store_and_reuse.status = READY can be reassigned via POST /rest/it/agreements/{agreement_id}/reassign.

Token scopes: it-agreements:read

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2026-12-15.

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/

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Query parameters

cursorstringOptional
Indicates where the next page of results starts, as returned in a paginated list response
limitintegerOptional1-100Defaults to 20
Return a page of results with given number of records
statusenumOptional
Filter agreements by status. Repeat the key to filter on multiple values.
Allowed values:
typeenumOptional
Filter agreements by type. Repeat the key to filter on multiple values.
Allowed values:
store_and_reuse_statusenumOptional

Filter rentals by store-and-reuse status. Repeat the key to filter on multiple values.

Allowed values:
hris_profile_idstringOptionalformat: "uuid"
Filter by the HRIS profile id currently holding the agreement.

Response

OK
datalist of objects
has_moreboolean
Whether there are more results available
next_cursorstring or null
Cursor to the next page
total_countlong
Total number of records

Errors

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