Skip to content

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.

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 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.organization_structure.get_organization_structures(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.offsetintegerOptionalDefault: 0
Format: int64
Maximum: 999999999
Minimum: 0
query.limitnumberOptionalFormat: double
Maximum: 200
Minimum: 1

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Organization Structures — 200 response body

Referenced models: Get Organization Structures — 200 response body

Get Organization Structures — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe date and time when the Org Structure was created.
Format: date-time
editablebooleanOptionalWhether the caller can edit the Org Structure.
enable_rolesbooleanOptionalWhether the Org Structure has Roles enabled.
external_idJSONOptional
external_id (anyOf 1)stringAlternativeThe external identifier of the Org Structure.
external_id (anyOf 2)nullAlternativeThe external identifier of the Org Structure.
idstringOptionalThe unique identifier of the Org Structure.
Format: uuid
is_multiselectbooleanOptionalWhether the Org Structure is multiselect.
namestringOptionalThe name of the Org Structure.
rolesarrayOptional
roles[]ModelEach itemExpand Get Organization Structures — 200 response body — data item roles item
teamsarrayOptional
teams[]ModelEach itemExpand Get Organization Structures — 200 response body — data item teams item
teams_countJSONOptional
teams_count (anyOf 1)integerAlternativeThe number of Teams in the Org Structure.
teams_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier of the Role.
Format: uuid
namestringOptionalThe name of the Role.
Get Organization Structures — 200 response body — data item teams item
FieldTypePresenceDescription and constraints
$objectRoot
childrenarrayOptional
children[]ModelEach itemExpand Get Organization Structure — 200 response body — data teams item
created_atstringOptionalThe date and time when the Org Structure was created.
Format: date-time
external_idJSONOptional
external_id (anyOf 1)stringAlternativeThe external identifier of the Team.
external_id (anyOf 2)nullAlternativeThe external identifier of the Team.
idstringOptionalThe unique identifier of the Team.
Format: uuid
namestringOptionalThe name of the Team.
name_routeJSONOptional
name_route (anyOf 1)stringAlternativeThe route name of the Team.
name_route (anyOf 2)nullAlternativeThe route name of the Team.
parentJSONOptional
parent (anyOf 1)stringAlternativeThe name of the parent Org Structure.
parent (anyOf 2)nullAlternativeThe 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
FieldTypePresenceDescription and constraints
$objectRoot

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"}

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.