itAgreements

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.

Token scopes: it-agreements:read

get/it/agreements

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/it/agreements
  • Auth: HTTP bearer

Query parameters

cursorstring

Indicates where the next page of results starts, as returned in a paginated list response

limitinteger

Return a page of results with given number of records

status'ACTIVE' | 'CANCELED' | 'ENDED' | 'PENDING'

Filter agreements by status. Repeat the key to filter on multiple values.

type'MANAGEMENT' | 'PURCHASE' | 'RENTAL'

Filter agreements by type. Repeat the key to filter on multiple values.

store_and_reuse_status'COMPLETED' | 'IN_PROGRESS' | 'NOT_STARTED' | 'READY'

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

hris_profile_idstring uuid

Filter by the HRIS profile id currently holding the agreement.

Response

OK

has_moreboolean required

Whether there are more results available

next_cursorstring nullable required

Cursor to the next page

total_countinteger required

Total number of records

Changes

No recorded changes to this operation across all 1 revision of this API.