Skip to content

Deel: Get the roles of the current organization

Deel organizations.getTheRolesOfTheCurrentOrganization: arguments, response, policy and SDK examples.

← Organizations operations · Get started

Operation deel.organizations_gettherolesofthecurrentorganization_v2026_01_01

Provider route: GET /roles. 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["organizations"]["getTheRolesOfTheCurrentOrganization"]>[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.organizations.getTheRolesOfTheCurrentOrganization(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.organizations.get_the_roles_of_the_current_organization(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get the roles of the current organization — 200 response body

Referenced models: Get the roles of the current organization — 200 response body

Get the roles of the current organization — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get the roles of the current organization — 200 response body — data item

Referenced models: Get the roles of the current organization — 200 response body — data item

Get the roles of the current organization — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
hrisOrgStructureIdJSONOptional
hrisOrgStructureId (anyOf 1)stringAlternativeThe HRIS (Human Resource Information System) organization structure ID associated with the role, if applicable.
hrisOrgStructureId (anyOf 2)nullAlternativeThe HRIS (Human Resource Information System) organization structure ID associated with the role, if applicable.
idJSONRequired within parent
id (anyOf 1)numberAlternativeThe unique identifier for the role.
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parentThe name of the role.
scopestringRequired within parentThe scope of the role, which can define the level of access. For example, 'ORGANIZATION' represents a global role within the organization.

SDK function policy ID: deel.organizations_gettherolesofthecurrentorganization_v2026_01_01. Catalog operation: organizations_gettherolesofthecurrentorganization_v2026_01_01. 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.