Deel: Retrieve an agreement — 200 response body — data
Retrieve an agreement: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve an agreement — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actions | Model | Required within parent | Expand Retrieve an agreement — 200 response body — data actions Snapshot of which agreement-level actions are currently callable on this agreement. |
assigned_hris_profile | JSON | Required within parent | Current holder of the agreement, if any. `null` while the agreement is between users (e.g. after POST /assets/{id}/store). |
assigned_hris_profile (anyOf 1) | Model | Alternative | Expand Retrieve an agreement — 200 response body — data assigned hris profile emails, first name, hris profile id, last name |
assigned_hris_profile (anyOf 2) | null | Alternative | |
billing_entity_id | JSON | Required within parent | |
billing_entity_id (anyOf 1) | string | Alternative | ID of the billing entity that pays for this agreement. `null` when the billing entity is no longer active. Format: uuid |
billing_entity_id (anyOf 2) | null | Alternative | ID of the billing entity that pays for this agreement. `null` when the billing entity is no longer active. Format: uuid |
created_at | string | Required within parent | When the agreement was created. Format: date-time |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | Agreement end date. `null` while the agreement is open. Format: date |
end_date (anyOf 2) | null | Alternative | Agreement end date. `null` while the agreement is open. Format: date |
id | string | Required within parent | Unique identifier of the agreement. Format: uuid |
product | Model | Required within parent | Expand Retrieve an agreement — 200 response body — data product The product this agreement is for. |
public_id | string | Required within parent | Public identifier of the agreement. |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Agreement start date. Format: date |
start_date (anyOf 2) | null | Alternative | Agreement start date. Format: date |
status | string | Required within parent | Normalised agreement status. Known values: ACTIVE, CANCELED, ENDED, PENDING |
store_and_reuse | JSON | Required within parent | Store-and-reuse block. Present only when the agreement is a rental with store-and-reuse enabled. |
store_and_reuse (anyOf 1) | Model | Alternative | Expand Retrieve an agreement — 200 response body — data / store_and_reuse / status: COMPLETED, IN PROGRESS, READY |
store_and_reuse (anyOf 2) | null | Alternative | |
type | string | Required within parent | Agreement type. Known values: MANAGEMENT, PURCHASE, RENTAL |
updated_at | string | Required within parent | When the agreement was last updated. Format: date-time |
variant_id | string | Required within parent | The currently-assigned product variant. Format: uuid |
Referenced models: Retrieve an agreement — 200 response body — data assigned hris profile emails, first name, hris profile id, last name, Retrieve an agreement — 200 response body — data actions, Retrieve an agreement — 200 response body — data product, Retrieve an agreement — 200 response body — data / store_and_reuse / status: COMPLETED, IN PROGRESS, READY