Skip to content

Deel: Get Profiles Assigned to Policy

Deel timeOff.getProfilesAssignedToPolicy: arguments, response, policy and SDK examples.

← Time off operations · Get started

Operation deel.timeoff_getprofilesassignedtopolicy_v2026_09_09

Provider route: GET /time-offs/policy/{policy_id}/assignments. 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["timeOff"]["getProfilesAssignedToPolicy"]>[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.timeOff.getProfilesAssignedToPolicy(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.time_off.get_profiles_assigned_to_policy(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.policy_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.page_sizeintegerOptionalMaximum: 100
Minimum: 1
query.nextstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Profiles Assigned to Policy — 200 response body

Referenced models: Get Profiles Assigned to Policy — 200 response body

Get Profiles Assigned to Policy — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentProfiles currently assigned to the policy
data[]ModelEach itemExpand Get Profiles Assigned to Policy — 200 response body — data item
has_next_pagebooleanRequired within parentIndicates if there are more results available beyond the current page
nextJSONOptional
next (anyOf 1)stringAlternativeOpaque cursor to fetch the next page of results. Null when there are no more results
next (anyOf 2)nullAlternativeOpaque cursor to fetch the next page of results. Null when there are no more results

Referenced models: Get Profiles Assigned to Policy — 200 response body — data item

Get Profiles Assigned to Policy — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
countryJSONRequired within parent
country (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code of the assigned worker's employment. Null if not set
country (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code of the assigned worker's employment. Null if not set
emailstringRequired within parentPersonal email address of the assigned worker
Format: email
hris_profile_idJSONRequired within parent
hris_profile_id (anyOf 1)stringAlternativeHRIS profile UID of the assigned worker. Null if the assigned profile has no linked HRIS profile
Format: uuid
hris_profile_id (anyOf 2)nullAlternativeHRIS profile UID of the assigned worker. Null if the assigned profile has no linked HRIS profile
Format: uuid
namestringRequired within parentFull name of the assigned worker
stateJSONOptional
state (anyOf 1)stringAlternativeState or region code of the assigned worker's employment, if applicable
state (anyOf 2)nullAlternativeState or region code of the assigned worker's employment, if applicable
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeWork email address of the assigned worker, if set
Format: email
work_email (anyOf 2)nullAlternativeWork email address of the assigned worker, if set
Format: email
worker_typestringRequired within parentType of worker relationship the assigned profile has with the organization
Known values: milestones_contractor, payg_contractor, time_based_contractor, eor, direct_employee, hris_direct_employee, peo, hris_placeholder, hris_direct_contractor

SDK function policy ID: deel.timeoff_getprofilesassignedtopolicy_v2026_09_09. Catalog operation: timeoff_getprofilesassignedtopolicy_v2026_09_09. 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: ["time-off:read"]

Pinned headers: {"X-Version": "2026-09-09"}

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.