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.
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["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 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.time_off.get_profiles_assigned_to_policy(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.policy_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.page_size | integer | Optional | Maximum: 100 Minimum: 1 |
query.next | string | Optional |
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 Get Profiles Assigned to Policy — 200 response body |
Referenced models: Get Profiles Assigned to Policy — 200 response body
Schemas
Section titled “Schemas”Get Profiles Assigned to Policy — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Profiles currently assigned to the policy |
data[] | Model | Each item | Expand Get Profiles Assigned to Policy — 200 response body — data item |
has_next_page | boolean | Required within parent | Indicates if there are more results available beyond the current page |
next | JSON | Optional | |
next (anyOf 1) | string | Alternative | Opaque cursor to fetch the next page of results. Null when there are no more results |
next (anyOf 2) | null | Alternative | Opaque 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Required within parent | |
country (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country code of the assigned worker's employment. Null if not set |
country (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country code of the assigned worker's employment. Null if not set |
email | string | Required within parent | Personal email address of the assigned worker Format: email |
hris_profile_id | JSON | Required within parent | |
hris_profile_id (anyOf 1) | string | Alternative | HRIS profile UID of the assigned worker. Null if the assigned profile has no linked HRIS profile Format: uuid |
hris_profile_id (anyOf 2) | null | Alternative | HRIS profile UID of the assigned worker. Null if the assigned profile has no linked HRIS profile Format: uuid |
name | string | Required within parent | Full name of the assigned worker |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State or region code of the assigned worker's employment, if applicable |
state (anyOf 2) | null | Alternative | State or region code of the assigned worker's employment, if applicable |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | Work email address of the assigned worker, if set Format: email |
work_email (anyOf 2) | null | Alternative | Work email address of the assigned worker, if set Format: email |
worker_type | string | Required within parent | Type 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}