Skip to content

Deel: Get my current personal profile

Deel people.getMyCurrentPersonalProfile: arguments, response, policy and SDK examples.

← People operations · Get started

Operation deel.people_getmycurrentpersonalprofile_v2026_01_01

Provider route: GET /people/me. 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["people"]["getMyCurrentPersonalProfile"]>[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.people.getMyCurrentPersonalProfile(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.people.get_my_current_personal_profile(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get my current personal profile — 200 response body

Referenced models: Get my current personal profile — 200 response body

Get my current personal profile — 200 response body
FieldTypePresenceDescription and constraints
$objectRootPeople object representing a Deel
avatar_urlJSONOptional
avatar_url (anyOf 1)stringAlternativeURL of the user's avatar
avatar_url (anyOf 2)nullAlternativeURL of the user's avatar
client_countryJSONOptional
client_country (anyOf 1)stringAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
client_country (anyOf 2)nullAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
contractor_countryJSONOptional
contractor_country (anyOf 1)stringAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
contractor_country (anyOf 2)nullAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
emailstringOptionalEmail address of the user
first_namestringOptionalFirst name of the user
full_namestringOptionalFull name of the user
hris_enabledJSONOptional
hris_enabled (anyOf 1)booleanAlternativeHRIS feature enabled.
hris_enabled (anyOf 2)nullAlternativeHRIS feature enabled.
hris_organization_user_idJSONOptional
hris_organization_user_id (anyOf 1)stringAlternativeHRIS Organization User ID of the user. Used in products like Deel Engage.
Format: uuid
hris_organization_user_id (anyOf 2)nullAlternativeHRIS Organization User ID of the user. Used in products like Deel Engage.
Format: uuid
idJSONOptional
id (anyOf 1)numberAlternativeUnique identifier for the user profile
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
last_namestringOptionalLast name of the user
middle_nameJSONOptional
middle_name (anyOf 1)stringAlternativeMiddle name of the user
middle_name (anyOf 2)nullAlternativeMiddle name of the user
organization_idJSONOptional
organization_id (anyOf 1)numberAlternativeUnique identifier for the organization
Format: double
organization_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
organization_nameJSONOptional
organization_name (anyOf 1)stringAlternativeName of the organization
organization_name (anyOf 2)nullAlternativeName of the organization
profile_typestringOptionalType of profile
Known values: client, contractor, icp, direct_employee, hris_direct_employee, peo_employee, service_account
slack_team_idJSONOptional
slack_team_id (anyOf 1)stringAlternativeUser's team slack id
slack_team_id (anyOf 2)nullAlternativeUser's team slack id
slack_user_idJSONOptional
slack_user_id (anyOf 1)stringAlternativeUser's slack id
slack_user_id (anyOf 2)nullAlternativeUser's slack id
user_idJSONOptional
user_id (anyOf 1)numberAlternativeUnique identifier for the user
Format: double
user_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
usernamestringOptionalUsername of the user

SDK function policy ID: deel.people_getmycurrentpersonalprofile_v2026_01_01. Catalog operation: people_getmycurrentpersonalprofile_v2026_01_01. 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: ["worker:read", "people: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.