Skip to content

Deel: Retrieve an agreement

Deel itAgreements.retrieveAnItAgreement: arguments, response, policy and SDK examples.

← IT agreements operations · Get started

Operation deel.itagreements_retrieveanitagreement_v2026_09_15

Provider route: GET /it/agreements/{agreement_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["itAgreements"]["retrieveAnItAgreement"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.itAgreements.retrieveAnItAgreement(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.it_agreements.retrieve_an_it_agreement(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.agreement_idstringRequired within parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve an agreement — 200 response body

Referenced models: Retrieve an agreement — 200 response body

4 more schemas are linked from the tables above, on the schema pages.

Retrieve an agreement — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve an agreement — 200 response body — data

Referenced models: Retrieve an agreement — 200 response body — data

Retrieve an agreement — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
actionsModelRequired within parentExpand Retrieve an agreement — 200 response body — data actions
Snapshot of which agreement-level actions are currently callable on this agreement.
assigned_hris_profileJSONRequired within parentCurrent 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)ModelAlternativeExpand Retrieve an agreement — 200 response body — data assigned hris profile emails, first name, hris profile id, last name
assigned_hris_profile (anyOf 2)nullAlternative
billing_entity_idJSONRequired within parent
billing_entity_id (anyOf 1)stringAlternativeID 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)nullAlternativeID of the billing entity that pays for this agreement. `null` when the billing entity is
no longer active.
Format: uuid
created_atstringRequired within parentWhen the agreement was created.
Format: date-time
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeAgreement end date. `null` while the agreement is open.
Format: date
end_date (anyOf 2)nullAlternativeAgreement end date. `null` while the agreement is open.
Format: date
idstringRequired within parentUnique identifier of the agreement.
Format: uuid
productModelRequired within parentExpand Retrieve an agreement — 200 response body — data product
The product this agreement is for.
public_idstringRequired within parentPublic identifier of the agreement.
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeAgreement start date.
Format: date
start_date (anyOf 2)nullAlternativeAgreement start date.
Format: date
statusstringRequired within parentNormalised agreement status.
Known values: ACTIVE, CANCELED, ENDED, PENDING
store_and_reuseJSONRequired within parentStore-and-reuse block. Present only when the agreement is a rental with store-and-reuse
enabled.
store_and_reuse (anyOf 1)ModelAlternativeExpand Retrieve an agreement — 200 response body — data / store_and_reuse / status: COMPLETED, IN PROGRESS, READY
store_and_reuse (anyOf 2)nullAlternative
typestringRequired within parentAgreement type.
Known values: MANAGEMENT, PURCHASE, RENTAL
updated_atstringRequired within parentWhen the agreement was last updated.
Format: date-time
variant_idstringRequired within parentThe 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

Retrieve an agreement — 200 response body — data assigned hris profile emails, first name, hris profile id, last name
FieldTypePresenceDescription and constraints
$objectRootCurrent holder of the agreement, if any. `null` while the agreement is between users
(e.g. after POST /assets/{id}/store).
emailsarrayRequired within parentArray of user email addresses
emails[]stringEach itemFormat: email
first_namestringRequired within parentFirst name of the user
hris_profile_idstringRequired within parentThe unique identifier of the HRIS profile of the assigned user
Format: uuid
last_namestringRequired within parentLast name of the user
Retrieve an agreement — 200 response body — data actions
FieldTypePresenceDescription and constraints
$objectRootSnapshot of which agreement-level actions are currently callable on this agreement.
reuseModelRequired within parentExpand Retrieve an agreement — 200 response body — data actions reuse
Backs POST /agreements/{agreement_id}/reassign.

Referenced models: Retrieve an agreement — 200 response body — data actions reuse

Retrieve an agreement — 200 response body — data product
FieldTypePresenceDescription and constraints
$objectRootThe product this agreement is for.
brandstringRequired within parentProduct brand
categoryModelRequired within parentExpand Retrieve a product's catalog details — 200 response body — data category
Product category
idstringRequired within parentUnique identifier of the product
Format: uuid
namestringRequired within parentProduct name

Referenced models: Retrieve a product's catalog details — 200 response body — data category

Retrieve an agreement — 200 response body — data / store_and_reuse / status: COMPLETED, IN PROGRESS, READY
FieldTypePresenceDescription and constraints
$objectRootStore-and-reuse block. Present only when the agreement is a rental with store-and-reuse
enabled.
statusstringRequired within parentCurrent state of the store-and-reuse lifecycle for this rental contract.
Known values: COMPLETED, IN_PROGRESS, READY
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

Retrieve a product's catalog details — 200 response body — data category
FieldTypePresenceDescription and constraints
$stringRootProduct category
Known values: ADAPTER, CABLE, CHAIR, CHARGER, COMPACT_DESKTOP, DESK, DESKTOP, DESK_RISER, DESK_TIDY, DOCKING_STATION, DONGLE, FOOTREST, HEADSET, KEYBOARD, LAPTOP, LAPTOP_STAND, MICE_TRACKPAD, MOBILE_DEVICE, MONITOR, MONITOR_ARM, OTHER, PRINTER, SHREDDER, STANDING_MAT, TABLET, TASK_LIGHT, WEBCAM, WELCOME_PACK, WIFI_RANGE_EXTENDER
Retrieve an agreement — 200 response body — data actions reuse details reassignable in, reusable variants
FieldTypePresenceDescription and constraints
$objectRootPopulated when `enabled = true` and the action has caller-relevant context to surface
(see per-slot documentation). Null otherwise.
reassignable_inarrayRequired within parentCountries the contract can currently be reassigned to (customs / entity constraints).
reassignable_in[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item available countries item
reusable_variantsarrayRequired within parentThe subset of the parent product's variants that can be reassigned via store-and-reuse.
The original contract variant is appended as a fallback when the store-and-reuse filter
returns none.
reusable_variants[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item

Referenced models: Retrieve a product's catalog details — 200 response body — data variants item available countries item, Retrieve a product's catalog details — 200 response body — data variants item

SDK function policy ID: deel.itagreements_retrieveanitagreement_v2026_09_15. Catalog operation: itagreements_retrieveanitagreement_v2026_09_15. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["it-agreements:read"]

Pinned headers: {"X-Version": "2026-09-15"}

Official provider source

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.