List agreements

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`. Results are cursor-paginated. **Token scopes**: `it-agreements: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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
OR
AuthorizationBearer
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

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. NOT_STARTED is not accepted (omit the filter to include agreements without store-and-reuse).

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