Skip to content

Deel: Retrieve an agreement — 200 response body — data actions reuse

Retrieve an agreement: 200 response body, field data / actions / reuse. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Retrieve an agreement — 200 response body — data actions reuse

FieldTypePresenceDescription and constraints
$objectRootBacks POST /agreements/{agreement_id}/reassign.
detailsJSONRequired within parentPopulated when `enabled = true` and the action has caller-relevant context to surface
(see per-slot documentation). Null otherwise.
details (anyOf 1)ModelAlternativeExpand Retrieve an agreement — 200 response body — data actions reuse details reassignable in, reusable variants
details (anyOf 2)nullAlternative
disabled_reasonJSONRequired within parentPopulated when `is_enabled = false`; the single reason code the storefront gave for the
disabled state. Not a list — matches V2 action-slot semantics.
disabled_reason (anyOf 1)stringAlternativePopulated when `is_enabled = false`; the single reason code the storefront gave for the
disabled state. Not a list — matches V2 action-slot semantics.
Known values: CONTRACT_HAS_ACTIVE_ASSIGNMENT, CONTRACT_IS_NOT_ACTIVE, CONTRACT_IS_NOT_RENTAL, CONTRACT_IS_NOT_REUSE_ENABLED, CONTRACT_TYPE_NOT_ALLOWED, ORGANIZATION_NOT_ACTIVE
disabled_reason (anyOf 2)nullAlternative
is_enabledbooleanRequired within parentWhether the action is currently callable on this agreement.

Referenced models: Retrieve an agreement — 200 response body — data actions reuse details reassignable in, reusable variants

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.