Skip to content

Deel: Retrieve the organization's offer settings

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

← ATS operations · Get started

Operation deel.ats_retrieveorganizationoffersettings_v2026_11_02

Provider route: GET /ats/offer-settings. 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"]["retrieveOrganizationOfferSettings"]>[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.retrieveOrganizationOfferSettings(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.retrieve_organization_offer_settings(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 Retrieve the organization’s offer settings — 200 response body

Referenced models: Retrieve the organization’s offer settings — 200 response body

Retrieve the organization's offer settings — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve the organization's offer settings — 200 response body — data
The organization's offer settings

Referenced models: Retrieve the organization's offer settings — 200 response body — data

Retrieve the organization's offer settings — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe organization's offer settings
approval_exempt_fieldsarrayRequired within parentOffer fields whose edits do not send an approved offer back to approval
approval_exempt_fields[]stringEach itemOffer field
Known values: WORKER_TYPE, COMPENSATION_AMOUNT, COMPENSATION_CURRENCY, COMPENSATION_PERIOD_SLUG, JOB_TITLE, COUNTRY_CODE, START_DATE, EXPIRES_AT, CUSTOM_FIELDS, ADDITIONAL_DETAILS, OPENING_ID
default_approval_rule_idJSONRequired within parent
default_approval_rule_id (anyOf 1)stringAlternativeID of the default approval rule for offers
Format: uuid
default_approval_rule_id (anyOf 2)nullAlternativeID of the default approval rule for offers
Format: uuid
is_approval_requiredbooleanRequired within parentWhether every offer must go through an approval

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