Skip to content

Deel: Retrieve a single User

Deel users.getUserById: arguments, response, policy and SDK examples.

← Users operations · Get started

Operation deel.users_getuserbyid

Provider route: GET /Users/{hris_profile_id}. 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"]["getUserById"]>[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.getUserById(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_user_by_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.hris_profile_idstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a single User — 200 response body

Referenced models: Retrieve a single User — 200 response body

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

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

Referenced models: Retrieve a single User — 200 response body — emails item, Retrieve a single User — 200 response body — addresses item, Retrieve a single User — 200 response body — meta, Retrieve a single User — 200 response body — name, Retrieve a single User — 200 response body — phone Numbers item, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User

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
Retrieve a single User — 200 response body — 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}$
localitystringOptional
postalCodestringOptional
regionstringOptional
streetAddressstringOptional
typestringOptional
Retrieve a single User — 200 response body — meta
FieldTypePresenceDescription and constraints
$objectRoot
createdstringOptionalFormat: date-time
lastModifiedstringOptionalFormat: date-time
locationstringOptional
resourceTypestringOptionalKnown values: User, Group
Retrieve a single User — 200 response body — name
FieldTypePresenceDescription and constraints
$objectRoot
familyNamestringRequired within parent
givenNamestringRequired within parent
Retrieve a single User — 200 response body — phone Numbers item
FieldTypePresenceDescription and constraints
$objectRoot
primarybooleanRequired within parentDefault: false
typestringRequired within parentKnown values: home, work, other
valuestringRequired within parent
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
FieldTypePresenceDescription and constraints
$objectRoot
costCenterstringOptional
departmentstringOptional
managerModelOptionalExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
organizationstringOptional

Referenced models: Retrieve a single User — 200 response body — 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
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track
FieldTypePresenceDescription and constraints
$objectRootActive job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission.
idstringOptionalJob profile id.
jobFamilyJSONOptionalJob family of the job profile.
jobFamily (anyOf 1)ModelAlternativeExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Job family of the job profile
jobFamily (anyOf 2)nullAlternative
jobFamilyGroupJSONOptionalJob family group of the job family.
jobFamilyGroup (anyOf 1)ModelAlternativeExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Group Job family group of the job family
jobFamilyGroup (anyOf 2)nullAlternative
levelJSONOptional
level (anyOf 1)JSONAlternative
level (anyOf 1) (anyOf 1)integerAlternativeJob profile level.
level (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
level (anyOf 2)nullAlternativeJob profile level.
namestringOptionalJob profile name.
trackJSONOptional
track (anyOf 1)stringAlternativeJob profile track, as configured in job architecture (free text).
track (anyOf 2)nullAlternativeJob profile track, as configured in job architecture (free text).

Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Job family of the job profile, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Group Job family group of the job family

Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptional
valueJSONOptional
value (anyOf 1)stringAlternative
value (anyOf 2)nullAlternative
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User end Date
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeFormat: date-time
$ (anyOf 2)stringAlternativeKnown values: "" (empty string)

SDK function policy ID: deel.users_getuserbyid. Catalog operation: users_getuserbyid. 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.