Deel: List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917
Deel itPolicies.listItPolicyUsersVariantItpoliciesListitpolicyusersV20260917: arguments, response, policy and SDK examples.
← IT policies operations · Get started
Operation deel.itpolicies_listitpolicyusers_v2026_09_17
Provider route: GET /it/policies/{policy_id}/users. 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["itPolicies"]["listItPolicyUsersVariantItpoliciesListitpolicyusersV20260917"]>[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.itPolicies.listItPolicyUsersVariantItpoliciesListitpolicyusersV20260917(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_policies.list_it_policy_users_variant_itpolicies_listitpolicyusers_v2026_09_17(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.policy_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.cursor | string | Optional | |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
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 users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body |
Referenced models: List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body
Schemas
Section titled “Schemas”List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 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 users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body — data item
List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body — data item address User address details |
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 |
Referenced models: List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body — data item address
List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body — data item address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User address details |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | City name |
city (anyOf 2) | null | Alternative | City name |
country | Model | Required within parent | Expand Cancel an IT order — 200 response body — data delivery address country Country code |
date_of_birth | JSON | Required within parent | |
date_of_birth (anyOf 1) | string | Alternative | Date of birth (applicable for some address types) Format: date |
date_of_birth (anyOf 2) | null | Alternative | Date of birth (applicable for some address types) Format: date |
delivery_instructions | JSON | Required within parent | |
delivery_instructions (anyOf 1) | string | Alternative | Special instructions for deliveries |
delivery_instructions (anyOf 2) | null | Alternative | Special instructions for deliveries |
id | string | Required within parent | Unique identifier of the address Format: uuid |
is_valid | boolean | Required within parent | Whether the address passes validation |
line1 | JSON | Required within parent | |
line1 (anyOf 1) | string | Alternative | Address line 1 |
line1 (anyOf 2) | null | Alternative | Address line 1 |
line2 | JSON | Required within parent | |
line2 (anyOf 1) | string | Alternative | Address line 2 |
line2 (anyOf 2) | null | Alternative | Address line 2 |
passport_number | JSON | Required within parent | |
passport_number (anyOf 1) | string | Alternative | Passport number (applicable for some address types) |
passport_number (anyOf 2) | null | Alternative | Passport number (applicable for some address types) |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Phone number |
phone_number (anyOf 2) | null | Alternative | Phone number |
post_code | JSON | Required within parent | |
post_code (anyOf 1) | string | Alternative | Post code |
post_code (anyOf 2) | null | Alternative | Post code |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | State code or name |
state (anyOf 2) | null | Alternative | State code or name |
tax_id_number | JSON | Required within parent | |
tax_id_number (anyOf 1) | string | Alternative | Tax ID number (applicable for some address types) |
tax_id_number (anyOf 2) | null | Alternative | Tax ID number (applicable for some address types) |
type | string | Required within parent | Type of the address Known values: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER |
Referenced models: Cancel an IT order — 200 response body — data delivery address country
Cancel an IT order — 200 response body — data delivery address country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Country code 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.itpolicies_listitpolicyusers_v2026_09_17. Catalog operation: itpolicies_listitpolicyusers_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-policies:read"]
Pinned headers: {"X-Version": "2026-09-17"}