Deel: List products in the catalog

← it_products operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.itproducts_listitproducts_v2026_09_17

Provider route: GET /it/products. Alter supplies the connection’s credentials and routing.

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["itProducts"]["listItProducts"]>[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.itProducts.listItProducts(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_products.list_it_products(arguments)
        result = await call.wait()
        return result.body_json()

Input

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.country	string	Optional
query.stock_condition	string	Optional	One of: NEW, REFURBISHED
query.acquisition_types	array	Optional
query.acquisition_types[]	string	Each item	One of: PURCHASE, RENTAL, REUSE
query.search	string	Optional
query.category	string	Optional	One of: 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
query.operating_systems	array	Optional
query.operating_systems[]	string	Each item	One of: ANDROID_PHONE, ANDROID_TABLET, CHROME_OS, IOS_PHONE, IOS_TABLET, LINUX, MACOS, WINDOWS
query.keyboard_layouts	array	Optional
query.keyboard_layouts[]	Model	Each item	Expand List products in the catalog — request body — query keyboard layouts item
query.brands	array	Optional
query.brands[]	string	Each item
query.it_policy_ids	array	Optional
query.it_policy_ids[]	string	Each item	Format: uuid
query.is_marketplace	boolean	Optional
headers	object	Required within parent	Additional keys: not allowed
headers.X-Beta	string	Required within parent	Default: true One of: true

Referenced models: List products in the catalog — request body — query keyboard layouts item

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 products in the catalog — 200 response body

Referenced models: List products in the catalog — 200 response body

Policy, approvals and errors

SDK function policy ID: deel.itproducts_listitproducts_v2026_09_17. Catalog operation: itproducts_listitproducts_v2026_09_17. 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-products:read"]

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

Official provider source