Deel: List users
Deel users.getUsers: arguments, response, policy and SDK examples.
← Users operations · Get started
Operation deel.users_getusers
Provider route: GET /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["users"]["getUsers"]>[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.users.getUsers(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.users.get_users(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.filter | Model | Optional | Expand List users — request body — query filter |
query.startIndex | string | Optional | Pattern: ^[0-9]+$ |
query.count | string | Optional | Pattern: ^[0-9]+$ |
Referenced models: List users — request body — query filter
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 — 200 response body |
Referenced models: List users — 200 response body
Schemas
Section titled “Schemas”7 more schemas are linked from the tables above, on the schema pages.
List users — request body — query filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | array | Alternative | |
$ (oneOf 2)[] | string | Each item |
List users — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
Resources | array | Optional | |
Resources[] | Model | Each item | Expand List users — 200 response body — Resources item |
itemsPerPage | JSON | Optional | |
itemsPerPage (anyOf 1) | integer | Alternative | Format: int64 |
itemsPerPage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schemas | array | Optional | |
schemas[] | string | Each item | Known values: urn:ietf:params:scim:api:messages:2.0:ListResponse |
startIndex | JSON | Optional | |
startIndex (anyOf 1) | integer | Alternative | Format: int64 |
startIndex (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalResults | JSON | Optional | |
totalResults (anyOf 1) | integer | Alternative | Format: int64 |
totalResults (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List users — 200 response body — Resources item
List users — 200 response body — Resources item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | boolean | Optional | Default: false |
addresses | array | Optional | |
addresses[] | Model | Each item | Expand List users — 200 response body — Resources item addresses item |
emails | array | Required within parent | |
emails[] | Model | Each item | Expand Retrieve a single User — 200 response body — emails item |
id | string | Optional | |
meta | Model | Required within parent | Expand List users — 200 response body — Resources item meta |
name | Model | Required within parent | Expand List users — 200 response body — Resources item name |
schemas | array | Required within parent | |
schemas[] | string | Each item | Known values: urn:ietf:params:scim:schemas:core:2.0:User |
title | string | Optional | |
urn:ietf:params:scim:schemas:extension:2.0:User | Model | Optional | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User | Model | Optional | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User |
userName | string | Required within parent | |
userType | string | Optional |
Referenced models: List users — 200 response body — Resources item addresses item, Retrieve a single User — 200 response body — emails item, List users — 200 response body — Resources item meta, List users — 200 response body — Resources item name, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
List users — 200 response body — Resources item addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
country (anyOf 2) | null | Alternative | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
lineTwo | string | Optional | |
locality | string | Optional | |
postalCode | string | Optional | |
region | string | Optional | |
streetAddress | string | Optional | |
type | string | Optional |
Retrieve a single User — 200 response body — emails item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
primary | boolean | Optional | Default: false |
type | string | Required within parent | Known values: home, work, other |
value | string | Required within parent |
List users — 200 response body — Resources item meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | string | Optional | |
lastModified | string | Optional | |
location | string | Optional | |
resourceType | string | Optional | Known values: User, Group |
List users — 200 response body — Resources item name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
familyName | JSON | Required within parent | |
familyName (anyOf 1) | string | Alternative | |
familyName (anyOf 2) | null | Alternative | |
givenName | JSON | Required within parent | |
givenName (anyOf 1) | string | Alternative | |
givenName (anyOf 2) | null | Alternative |
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
costCenter | string | Optional | |
customFields | object | Optional | Additional keys: see wildcard field |
customFields.* | string | Additional keys | |
department | string | Optional | |
manager | Model | Optional | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager |
organization | string | Optional | |
preferredFirstName | string | Optional | |
preferredLastName | string | Optional |
Referenced models: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | |
value (anyOf 2) | null | Alternative |
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
externalId | JSON | Optional | |
externalId (anyOf 1) | string | Alternative | |
externalId (anyOf 2) | null | Alternative | |
externalIdHierarchy | JSON | Optional | |
externalIdHierarchy (anyOf 1) | string | Alternative | |
externalIdHierarchy (anyOf 2) | null | Alternative | |
name | string | Optional | |
nameHierarchy | string | Optional | |
structureId | string | Optional | |
structureName | string | Optional |
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
displayName | string | Optional | |
email | string | Optional | |
value | string | Required within parent |
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.users_getusers. Catalog operation: users_getusers. 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: ["Users:read"]
Pinned headers: {"X-Version": "2026-01-01"}