Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootWorkers to give an IT seat.
hris_profile_idsarrayRequired within parentHRIS 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[]stringEach itemFormat: uuid
is_accepting_new_seat_subscriptionbooleanRequired within parentWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List IT seats — 200 response body — data item
has_morebooleanRequired within parentWhether there are more results available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to the next page
next_cursor (anyOf 2)nullAlternativeCursor to the next page
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of records
Format: int64
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
active_onJSONRequired within parent
active_on (anyOf 1)stringAlternativeDay the seat's paid features started being used. `null` while the seat is not in use.
Format: date
active_on (anyOf 2)nullAlternativeDay the seat's paid features started being used. `null` while the seat is not in use.
Format: date
assigned_atJSONRequired within parent
assigned_at (anyOf 1)stringAlternativeWhen the seat was given to its worker. `null` when the seat has never been assigned.
Format: date-time
assigned_at (anyOf 2)nullAlternativeWhen the seat was given to its worker. `null` when the seat has never been assigned.
Format: date-time
assigned_hris_profileJSONRequired within parentWorker holding the seat. `null` when the seat is free or its worker has no Deel HRIS profile.
assigned_hris_profile (anyOf 1)ModelAlternativeExpand List IT seats — 200 response body — data item assigned hris profile emails, first name, hris profile id, last name
assigned_hris_profile (anyOf 2)nullAlternative
created_atstringRequired within parentWhen the seat was created.
Format: date-time
deactivated_onJSONRequired within parent
deactivated_on (anyOf 1)stringAlternativeDay the seat was released. `null` while the seat is still held.
Format: date
deactivated_on (anyOf 2)nullAlternativeDay the seat was released. `null` while the seat is still held.
Format: date
declined_atJSONRequired within parent
declined_at (anyOf 1)stringAlternativeWhen the worker declined the seat. `null` unless the worker declined it.
Format: date-time
declined_at (anyOf 2)nullAlternativeWhen the worker declined the seat. `null` unless the worker declined it.
Format: date-time
idstringRequired within parentUnique identifier of the seat.
Format: uuid
statusstringRequired within parentCurrent 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

FieldTypePresenceDescription and constraints
$objectRootWorker holding the seat. `null` when the seat is free or its worker has no Deel HRIS profile.
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 the IT seat subscription — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
assigned_seatsJSONRequired within parent
assigned_seats (anyOf 1)integerAlternativeNumber of seats held by a worker, whether or not the seat's paid features are in use yet.
Format: int64
assigned_seats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
available_seatsJSONRequired within parent
available_seats (anyOf 1)integerAlternativeNumber of paid seats free to assign right now.
Format: int64
available_seats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentWhen the subscription was created.
Format: date-time
end_datestringRequired within parentLast day the subscription is in force.
Format: date
idstringRequired within parentUnique identifier of the IT seat subscription.
Format: uuid
monthly_seat_priceModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price
Price of each seat per month.
paid_seatsJSONRequired within parent
paid_seats (anyOf 1)integerAlternativeNumber of seats the organization pays for.
Format: int64
paid_seats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pending_approval_seatsJSONRequired within parent
pending_approval_seats (anyOf 1)integerAlternativeNumber of seats pending purchase approval. These do not consume a paid seat until approved.
Format: int64
pending_approval_seats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_datestringRequired within parentFirst day the subscription is in force.
Format: date
statusstringRequired within parentCurrent status of the subscription.
Known values: ACTIVE, EXPIRED, TRIAL
termstringRequired within parentCommitted 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

FieldTypePresenceDescription and constraints
$objectRootPrice of each seat per month.
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$stringRootThree-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

FieldTypePresenceDescription and constraints
$objectRootWorkers whose IT seat to release.
hris_profile_idsarrayRequired within parentHRIS 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[]stringEach itemFormat: uuid

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.