Deel: IT seats schemas
9 Deel schemas with complete fields and constraints.
← IT seats operations · All schemas
Assign workers to IT seats — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Workers to give an IT seat. |
hris_profile_ids | array | Required within parent | HRIS profile identifiers of the workers to give an IT seat. Between 1 and 100 unique ids per request; the whole request is rejected when any id is not found in your organization. |
hris_profile_ids[] | string | Each item | Format: uuid |
is_accepting_new_seat_subscription | boolean | Required within parent | Whether missing seats may be purchased. When true and the subscription has fewer free seats than the workers need, the missing seats are added to your organization's IT-seat subscription at its monthly seat price and billed immediately, bypassing the seat purchase approval your organization would go through in the Deel IT UI. When false (the default) the request fails with a conflict instead and nothing is changed. |
List IT seats — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List IT seats — 200 response body — data item |
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: List IT seats — 200 response body — data item
List IT seats — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active_on | JSON | Required within parent | |
active_on (anyOf 1) | string | Alternative | Day the seat's paid features started being used. `null` while the seat is not in use. Format: date |
active_on (anyOf 2) | null | Alternative | Day the seat's paid features started being used. `null` while the seat is not in use. Format: date |
assigned_at | JSON | Required within parent | |
assigned_at (anyOf 1) | string | Alternative | When the seat was given to its worker. `null` when the seat has never been assigned. Format: date-time |
assigned_at (anyOf 2) | null | Alternative | When the seat was given to its worker. `null` when the seat has never been assigned. Format: date-time |
assigned_hris_profile | JSON | Required within parent | Worker holding the seat. `null` when the seat is free or its worker has no Deel HRIS profile. |
assigned_hris_profile (anyOf 1) | Model | Alternative | Expand List IT seats — 200 response body — data item assigned hris profile emails, first name, hris profile id, last name |
assigned_hris_profile (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | When the seat was created. Format: date-time |
deactivated_on | JSON | Required within parent | |
deactivated_on (anyOf 1) | string | Alternative | Day the seat was released. `null` while the seat is still held. Format: date |
deactivated_on (anyOf 2) | null | Alternative | Day the seat was released. `null` while the seat is still held. Format: date |
declined_at | JSON | Required within parent | |
declined_at (anyOf 1) | string | Alternative | When the worker declined the seat. `null` unless the worker declined it. Format: date-time |
declined_at (anyOf 2) | null | Alternative | When the worker declined the seat. `null` unless the worker declined it. Format: date-time |
id | string | Required within parent | Unique identifier of the seat. Format: uuid |
status | string | Required within parent | Current status of the seat. Known values: ACTIVE, ASSIGNED, INACTIVE, PENDING_APPROVAL |
Referenced models: List IT seats — 200 response body — data item assigned hris profile emails, first name, hris profile id, last name
List IT seats — 200 response body — data item assigned hris profile emails, first name, hris profile id, last name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker holding the seat. `null` when the seat is free or its worker has no Deel HRIS profile. |
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 the IT seat subscription — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve the IT seat subscription — 200 response body — data |
Referenced models: Retrieve the IT seat subscription — 200 response body — data
Retrieve the IT seat subscription — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assigned_seats | JSON | Required within parent | |
assigned_seats (anyOf 1) | integer | Alternative | Number of seats held by a worker, whether or not the seat's paid features are in use yet. Format: int64 |
assigned_seats (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
available_seats | JSON | Required within parent | |
available_seats (anyOf 1) | integer | Alternative | Number of paid seats free to assign right now. Format: int64 |
available_seats (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | When the subscription was created. Format: date-time |
end_date | string | Required within parent | Last day the subscription is in force. Format: date |
id | string | Required within parent | Unique identifier of the IT seat subscription. Format: uuid |
monthly_seat_price | Model | Required within parent | Expand Retrieve the IT seat subscription — 200 response body — data monthly seat price Price of each seat per month. |
paid_seats | JSON | Required within parent | |
paid_seats (anyOf 1) | integer | Alternative | Number of seats the organization pays for. Format: int64 |
paid_seats (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pending_approval_seats | JSON | Required within parent | |
pending_approval_seats (anyOf 1) | integer | Alternative | Number of seats pending purchase approval. These do not consume a paid seat until approved. Format: int64 |
pending_approval_seats (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_date | string | Required within parent | First day the subscription is in force. Format: date |
status | string | Required within parent | Current status of the subscription. Known values: ACTIVE, EXPIRED, TRIAL |
term | string | Required within parent | Committed length of the subscription. Known values: 12_MONTHS, 24_MONTHS, 36_MONTHS, CUSTOM |
Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price
Retrieve the IT seat subscription — 200 response body — data monthly seat price
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Price of each seat per month. |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency Three-letter currency code for the price |
Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Three-letter currency code for the price Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BDT, BGN, BHD, BIF, BMD, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWD |
Unassign workers from IT seats — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Workers whose IT seat to release. |
hris_profile_ids | array | Required within parent | HRIS profile identifiers of the workers whose IT seat to release. Between 1 and 100 unique ids per request; the whole request is rejected when any id is not found in your organization. |
hris_profile_ids[] | string | Each item | Format: uuid |