Skip to content

Deel: Get integration consent

Deel integrations.getIntegrationConsent: arguments, response, policy and SDK examples.

← Integrations operations · Get started

Operation deel.integrations_getintegrationconsent_v2026_01_01

Provider route: GET /integrations/consent. 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["integrations"]["getIntegrationConsent"]>[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.integrations.getIntegrationConsent(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.integrations.get_integration_consent(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 integration consent — 200 response body

Referenced models: Get integration consent — 200 response body

Get integration consent — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Get integration consent — 200 response body — data

Referenced models: Get integration consent — 200 response body — data

Get integration consent — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
client_idstringOptionalClient ID associated with the consent.
created_atstringOptionalCreation date for the consent.
expires_atstringOptionalExpiration date for the consent.
idstringOptionalUnique identifier for the consent.
organization_idJSONOptional
organization_id (anyOf 1)stringAlternativeOrganization ID associated with the consent.
organization_id (anyOf 2)nullAlternativeOrganization ID associated with the consent.
profile_idJSONOptional
profile_id (anyOf 1)stringAlternativeProfile ID associated with the consent.
profile_id (anyOf 2)nullAlternativeProfile ID associated with the consent.
redirect_uristringOptionalRedirect URI for the consent.
scopestringOptionalScope of the consent.
statestringOptionalState of the consent.
statusstringOptionalStatus of the consent.
updated_atstringOptionalUpdate date for the consent.
user_emailJSONOptional
user_email (anyOf 1)stringAlternativeUser email associated with the consent.
user_email (anyOf 2)nullAlternativeUser email associated with the consent.
user_idJSONOptional
user_id (anyOf 1)stringAlternativeUser ID associated with the consent.
user_id (anyOf 2)nullAlternativeUser ID associated with the consent.
user_nameJSONOptional
user_name (anyOf 1)stringAlternativeUser name associated with the consent.
user_name (anyOf 2)nullAlternativeUser name associated with the consent.

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

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.