Deel: Get Organization Structures
Deel organizationStructure.getOrganizationStructures: arguments, response, policy and SDK examples.
← Organization structure operations · Get started
Operation deel.organizationstructure_getorganizationstructures
Provider route: GET /hris/organization_structures. 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["organizationStructure"]["getOrganizationStructures"]>[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.organizationStructure.getOrganizationStructures(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.organization_structure.get_organization_structures(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.offset | integer | Optional | Default: 0 Format: int64 Maximum: 999999999 Minimum: 0 |
query.limit | number | Optional | Format: double Maximum: 200 Minimum: 1 |
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 Organization Structures — 200 response body |
Referenced models: Get Organization Structures — 200 response body
Schemas
Section titled “Schemas”Get Organization Structures — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Get Organization Structures — 200 response body — data item |
Referenced models: Get Organization Structures — 200 response body — data item
Get Organization Structures — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The date and time when the Org Structure was created. Format: date-time |
editable | boolean | Optional | Whether the caller can edit the Org Structure. |
enable_roles | boolean | Optional | Whether the Org Structure has Roles enabled. |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external identifier of the Org Structure. |
external_id (anyOf 2) | null | Alternative | The external identifier of the Org Structure. |
id | string | Optional | The unique identifier of the Org Structure. Format: uuid |
is_multiselect | boolean | Optional | Whether the Org Structure is multiselect. |
name | string | Optional | The name of the Org Structure. |
roles | array | Optional | |
roles[] | Model | Each item | Expand Get Organization Structures — 200 response body — data item roles item |
teams | array | Optional | |
teams[] | Model | Each item | Expand Get Organization Structures — 200 response body — data item teams item |
teams_count | JSON | Optional | |
teams_count (anyOf 1) | integer | Alternative | The number of Teams in the Org Structure. |
teams_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Optional | The type of the Org Structure. |
Referenced models: Get Organization Structures — 200 response body — data item roles item, Get Organization Structures — 200 response body — data item teams item
Get Organization Structures — 200 response body — data item roles item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | The unique identifier of the Role. Format: uuid |
name | string | Optional | The name of the Role. |
Get Organization Structures — 200 response body — data item teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
children | array | Optional | |
children[] | Model | Each item | Expand Get Organization Structure — 200 response body — data teams item |
created_at | string | Optional | The date and time when the Org Structure was created. Format: date-time |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external identifier of the Team. |
external_id (anyOf 2) | null | Alternative | The external identifier of the Team. |
id | string | Optional | The unique identifier of the Team. Format: uuid |
name | string | Optional | The name of the Team. |
name_route | JSON | Optional | |
name_route (anyOf 1) | string | Alternative | The route name of the Team. |
name_route (anyOf 2) | null | Alternative | The route name of the Team. |
parent | JSON | Optional | |
parent (anyOf 1) | string | Alternative | The name of the parent Org Structure. |
parent (anyOf 2) | null | Alternative | The name of the parent Org Structure. |
Referenced models: Get Organization Structure — 200 response body — data teams item
Get Organization Structure — 200 response body — data teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.organizationstructure_getorganizationstructures. Catalog operation: organizationstructure_getorganizationstructures. 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: ["organizations:read"]
Pinned headers: {"X-Version": "2026-01-01"}