Skip to content

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.

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 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.users.get_users(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.filterModelOptionalExpand List users — request body — query filter
query.startIndexstringOptionalPattern: ^[0-9]+$
query.countstringOptionalPattern: ^[0-9]+$

Referenced models: List users — request body — query filter

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List users — 200 response body

Referenced models: List users — 200 response body

7 more schemas are linked from the tables above, on the schema pages.

List users — request body — query filter
FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)stringAlternative
$ (oneOf 2)arrayAlternative
$ (oneOf 2)[]stringEach item
List users — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
ResourcesarrayOptional
Resources[]ModelEach itemExpand List users — 200 response body — Resources item
itemsPerPageJSONOptional
itemsPerPage (anyOf 1)integerAlternativeFormat: int64
itemsPerPage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
schemasarrayOptional
schemas[]stringEach itemKnown values: urn:ietf:params:scim:api:messages:2.0:ListResponse
startIndexJSONOptional
startIndex (anyOf 1)integerAlternativeFormat: int64
startIndex (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalResultsJSONOptional
totalResults (anyOf 1)integerAlternativeFormat: int64
totalResults (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List users — 200 response body — Resources item

List users — 200 response body — Resources item
FieldTypePresenceDescription and constraints
$objectRoot
activebooleanOptionalDefault: false
addressesarrayOptional
addresses[]ModelEach itemExpand List users — 200 response body — Resources item addresses item
emailsarrayRequired within parent
emails[]ModelEach itemExpand Retrieve a single User — 200 response body — emails item
idstringOptional
metaModelRequired within parentExpand List users — 200 response body — Resources item meta
nameModelRequired within parentExpand List users — 200 response body — Resources item name
schemasarrayRequired within parent
schemas[]stringEach itemKnown values: urn:ietf:params:scim:schemas:core:2.0:User
titlestringOptional
urn:ietf:params:scim:schemas:extension:2.0:UserModelOptionalExpand 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:UserModelOptionalExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
userNamestringRequired within parent
userTypestringOptional

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
FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
country (anyOf 2)nullAlternativeMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
lineTwostringOptional
localitystringOptional
postalCodestringOptional
regionstringOptional
streetAddressstringOptional
typestringOptional
Retrieve a single User — 200 response body — emails item
FieldTypePresenceDescription and constraints
$objectRoot
primarybooleanOptionalDefault: false
typestringRequired within parentKnown values: home, work, other
valuestringRequired within parent
List users — 200 response body — Resources item meta
FieldTypePresenceDescription and constraints
$objectRoot
createdstringOptional
lastModifiedstringOptional
locationstringOptional
resourceTypestringOptionalKnown values: User, Group
List users — 200 response body — Resources item name
FieldTypePresenceDescription and constraints
$objectRoot
familyNameJSONRequired within parent
familyName (anyOf 1)stringAlternative
familyName (anyOf 2)nullAlternative
givenNameJSONRequired within parent
givenName (anyOf 1)stringAlternative
givenName (anyOf 2)nullAlternative
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
FieldTypePresenceDescription and constraints
$objectRoot
costCenterstringOptional
customFieldsobjectOptionalAdditional keys: see wildcard field
customFields.*stringAdditional keys
departmentstringOptional
managerModelOptionalExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
organizationstringOptional
preferredFirstNamestringOptional
preferredLastNamestringOptional

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
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptional
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
valueJSONOptional
value (anyOf 1)stringAlternative
value (anyOf 2)nullAlternative
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item
FieldTypePresenceDescription and constraints
$objectRoot
externalIdJSONOptional
externalId (anyOf 1)stringAlternative
externalId (anyOf 2)nullAlternative
externalIdHierarchyJSONOptional
externalIdHierarchy (anyOf 1)stringAlternative
externalIdHierarchy (anyOf 2)nullAlternative
namestringOptional
nameHierarchystringOptional
structureIdstringOptional
structureNamestringOptional
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
FieldTypePresenceDescription and constraints
$objectRoot
displayNamestringOptional
emailstringOptional
valuestringRequired within parent
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
FieldTypePresenceDescription and constraints
$objectRoot
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative

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"}

Official provider source

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.