Deel: List of worker relations
Deel workerRelations.getWorkerRelationProfile: arguments, response, policy and SDK examples.
← Worker relations operations · Get started
Operation deel.workerrelations_getworkerrelationprofile
Provider route: GET /hris/worker_relations/profile/{hrisProfileOid}. 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["workerRelations"]["getWorkerRelationProfile"]>[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.workerRelations.getWorkerRelationProfile(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.worker_relations.get_worker_relation_profile(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.hrisProfileOid | string | Required within parent | Format: uuid |
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 List of worker relations — 200 response body |
Referenced models: List of worker relations — 200 response body
Schemas
Section titled “Schemas”List of worker relations — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | An array containing the Worker Relations of the profile. It includes either the parent or child relations. |
data[] | Model | Each item | Expand List of worker relations — 200 response body — data item |
Referenced models: List of worker relations — 200 response body — data item
List of worker relations — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_relationships | array | Optional | An array containing the information about the child profiles in the relation. |
child_relationships[] | Model | Each item | Expand List of worker relations — 200 response body — data item child relationships item |
id | string | Optional | The ID of the relation type Format: uuid |
is_default | boolean | Optional | Whether this relation is default or not |
is_parent | boolean | Optional | Whether this relation is the parent or not |
name | string | Optional | The name of the relation type |
parent_relationship | JSON | Optional | An object that has information about the parent profile in the relation. |
parent_relationship (anyOf 1) | Model | Alternative | Expand List of worker relations — 200 response body — data item parent relationship first name, last name, profile id, relation id |
parent_relationship (anyOf 2) | null | Alternative |
Referenced models: List of worker relations — 200 response body — data item child relationships item, List of worker relations — 200 response body — data item parent relationship first name, last name, profile id, relation id
List of worker relations — 200 response body — data item child relationships item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_name | string | Optional | The first name of the child profile |
last_name | string | Optional | The last name of the child profile |
profile_id | string | Optional | The ID of the child profile Format: uuid |
relation_id | string | Optional | The ID of the relation between the profiles Format: uuid |
List of worker relations — 200 response body — data item parent relationship first name, last name, profile id, relation id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object that has information about the parent profile in the relation. |
first_name | string | Optional | The first name of the parent profile |
last_name | string | Optional | The last name of the parent profile |
profile_id | string | Optional | The ID of the parent profile Format: uuid |
relation_id | string | Optional | The ID of the relation between the profiles Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.workerrelations_getworkerrelationprofile. Catalog operation: workerrelations_getworkerrelationprofile. 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: ["profile:read"]
Pinned headers: {"X-Version": "2026-01-01"}