Deel: List IT seats
Deel itSeats.listItSeats: arguments, response, policy and SDK examples.
← IT seats operations · Get started
Operation deel.itseats_listitseats_v2026_09_25
Provider route: GET /it/seats. 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["itSeats"]["listItSeats"]>[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.itSeats.listItSeats(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_seats.list_it_seats(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 | array | Optional | |
query.status[] | string | Each item | One of: ACTIVE, ASSIGNED, INACTIVE, PENDING_APPROVAL |
query.hris_profile_id | array | Optional | |
query.hris_profile_id[] | string | Each item | 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 IT seats — 200 response body |
Referenced models: List IT seats — 200 response body
Schemas
Section titled “Schemas”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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.itseats_listitseats_v2026_09_25. Catalog operation: itseats_listitseats_v2026_09_25. 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-seats:read"]
Pinned headers: {"X-Version": "2026-09-25"}