Skip to content

Deel: List the active approval options for offers

Deel ats.listActiveOfferApprovalPolicies: arguments, response, policy and SDK examples.

← ATS operations · Get started

Operation deel.ats_listactiveofferapprovalpolicies_v2026_11_02

Provider route: GET /ats/offer-approval-policies. 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["ats"]["listActiveOfferApprovalPolicies"]>[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.ats.listActiveOfferApprovalPolicies(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.ats.list_active_offer_approval_policies(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List the active approval options for offers — 200 response body

Referenced models: List the active approval options for offers — 200 response body

List the active approval options for offers — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentActive approval options for offers
data[]ModelEach itemExpand List the active approval options for offers — 200 response body — data item
has_morebooleanRequired within parentAlways false: every option is returned at once
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: every option is returned at once
next_cursor (anyOf 2)nullAlternativeAlways null: every option is returned at once
total_countJSONRequired within parent
total_count (anyOf 1)numberAlternativeNumber of options returned
Format: double
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List the active approval options for offers — 200 response body — data item

List the active approval options for offers — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the approval policy or approval rule
description (anyOf 2)nullAlternativeDescription of the approval policy or approval rule
idstringRequired within parentID of the approval policy or approval rule
Format: uuid
namestringRequired within parentName of the approval policy or approval rule
typestringRequired within parentWhether the item is an approval policy or an approval rule, which decides the offer field its id goes in
Known values: APPROVAL_POLICY, APPROVAL_RULE

SDK function policy ID: deel.ats_listactiveofferapprovalpolicies_v2026_11_02. Catalog operation: ats_listactiveofferapprovalpolicies_v2026_11_02. 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: ["ats:read", "worker:read"]

Pinned headers: {"X-Version": "2026-11-02"}

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.