Deel: List agreements
Deel itAgreements.listItAgreements: arguments, response, policy and SDK examples.
← IT agreements operations · Get started
Operation deel.itagreements_listitagreements_v2026_09_15
Provider route: GET /it/agreements. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["listItAgreements"]>[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.listItAgreements(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.list_it_agreements(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.cursor | string | Optional | |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.status | string | Optional | One of: ACTIVE, CANCELED, ENDED, PENDING |
query.type | string | Optional | One of: MANAGEMENT, PURCHASE, RENTAL |
query.store_and_reuse_status | string | Optional | One of: COMPLETED, IN_PROGRESS, READY |
query.hris_profile_id | string | Optional | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List agreements — 200 response body |
Referenced models: List agreements — 200 response body
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
List agreements — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve an agreement — 200 response body — data |
has_more | boolean | Required within parent | Whether there are more results available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to the next page |
next_cursor (anyOf 2) | null | Alternative | Cursor to the next page |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of records Format: int64 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve an agreement — 200 response body — data
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
Retrieve an agreement — 200 response body — data assigned hris profile emails, first name, hris profile id, last name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current holder of the agreement, if any. `null` while the agreement is between users (e.g. after POST /assets/{id}/store). |
emails | array | Required within parent | Array of user email addresses |
emails[] | string | Each item | Format: email |
first_name | string | Required within parent | First name of the user |
hris_profile_id | string | Required within parent | The unique identifier of the HRIS profile of the assigned user Format: uuid |
last_name | string | Required within parent | Last name of the user |
Retrieve an agreement — 200 response body — data actions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Snapshot of which agreement-level actions are currently callable on this agreement. |
reuse | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The product this agreement is for. |
brand | string | Required within parent | Product brand |
category | Model | Required within parent | Expand Retrieve a product's catalog details — 200 response body — data category Product category |
id | string | Required within parent | Unique identifier of the product Format: uuid |
name | string | Required within parent | Product 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Store-and-reuse block. Present only when the agreement is a rental with store-and-reuse enabled. |
status | string | Required within parent | Current 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Backs POST /agreements/{agreement_id}/reassign. |
details | JSON | Required within parent | Populated when `enabled = true` and the action has caller-relevant context to surface (see per-slot documentation). Null otherwise. |
details (anyOf 1) | Model | Alternative | Expand Retrieve an agreement — 200 response body — data actions reuse details reassignable in, reusable variants |
details (anyOf 2) | null | Alternative | |
disabled_reason | JSON | Required within parent | Populated 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) | string | Alternative | Populated 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) | null | Alternative | |
is_enabled | boolean | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Product 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 a product's catalog details — 200 response body — data variants item available countries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.itagreements_listitagreements_v2026_09_15. Catalog operation: itagreements_listitagreements_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"}