Deel: List worker addresses
Deel people.getWorkerAddresses: arguments, response, policy and SDK examples.
← People operations · Get started
Operation deel.people_getworkeraddresses_v2026_10_28
Provider route: GET /people/{worker_id}/addresses. 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["people"]["getWorkerAddresses"]>[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.getWorkerAddresses(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.people.get_worker_addresses(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.worker_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.include_scheduled | boolean | Optional | Default: false |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
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 worker addresses — 200 response body |
Referenced models: List worker addresses — 200 response body
Schemas
Section titled “Schemas”List worker addresses — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Addresses of the worker. |
data[] | Model | Each item | Expand List worker addresses — 200 response body — data item |
Referenced models: List worker addresses — 200 response body — data item
List worker addresses — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | The city. |
city (anyOf 2) | null | Alternative | The city. |
contract_id | JSON | Required within parent | |
contract_id (anyOf 1) | string | Alternative | Contract the address belongs to; null for HOME and POSTAL addresses. |
contract_id (anyOf 2) | null | Alternative | Contract the address belongs to; null for HOME and POSTAL addresses. |
country | string | Required within parent | The two-letter country code. |
effective_date | JSON | Required within parent | |
effective_date (anyOf 1) | string | Alternative | Date (YYYY-MM-DD) from which this version of the address applies. Format: date |
effective_date (anyOf 2) | null | Alternative | Date (YYYY-MM-DD) from which this version of the address applies. Format: date |
id | string | Required within parent | Unique identifier of the address, shared by its current and scheduled versions. Format: uuid |
line_two | JSON | Required within parent | |
line_two (anyOf 1) | string | Alternative | The second address line. |
line_two (anyOf 2) | null | Alternative | The second address line. |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | The state. |
state (anyOf 2) | null | Alternative | The state. |
street | JSON | Required within parent | |
street (anyOf 1) | string | Alternative | The street address. |
street (anyOf 2) | null | Alternative | The street address. |
type | string | Required within parent | The type of the address. Contract addresses are read-only on this API. Known values: HOME, POSTAL, CONTRACT |
zip | JSON | Required within parent | |
zip (anyOf 1) | string | Alternative | The zip code. |
zip (anyOf 2) | null | Alternative | The zip code. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.people_getworkeraddresses_v2026_10_28. Catalog operation: people_getworkeraddresses_v2026_10_28. 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: ["people:read"]
Pinned headers: {"X-Version": "2026-10-28"}