Skip to content

Deel: List clearance requests

Deel clearanceRequests.listClearanceRequests: arguments, response, policy and SDK examples.

← Clearance requests operations · Get started

Operation deel.itclearancerequests_listclearancerequests_v2026_09_16

Earlier SDK releases reported this operation as deel.clearancerequests_listclearancerequests_v2026_09_16 (call.operation, and the managed operation on audit rows). The TypeScript resumed-call type still accepts that id, and a policy rule naming it still matches.

Provider route: GET /it/clearance-requests. 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["clearanceRequests"]["listClearanceRequests"]>[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.clearanceRequests.listClearanceRequests(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.clearance_requests.list_clearance_requests(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.statusstringOptionalOne of: CANCELLED, COMPLETED, DECIDED, PENDING_DECISION, PENDING_QUOTE, PENDING_RETURN
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 clearance requests — 200 response body

Referenced models: List clearance requests — 200 response body

List clearance requests — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List clearance requests — 200 response body — data item
has_morebooleanRequired within parentWhether there are more results available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to the next page
next_cursor (anyOf 2)nullAlternativeCursor to the next page
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of records
Format: int64
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List clearance requests — 200 response body — data item

List clearance requests — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
cancelled_reasonJSONRequired within parentReason the clearance request was cancelled, absent unless the status is CANCELLED
cancelled_reason (anyOf 1)stringAlternativeReason the clearance request was cancelled, absent unless the status is CANCELLED
Known values: DEADLINE_EXCEEDED, REQUESTED_BY_CUSTOMER
cancelled_reason (anyOf 2)nullAlternative
created_atstringRequired within parentCreation timestamp of the clearance request
Format: date-time
expires_atJSONRequired within parent
expires_at (anyOf 1)stringAlternativeTimestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies
Format: date-time
expires_at (anyOf 2)nullAlternativeTimestamp indicating when the request expires and the manager can no longer take action, absent when no deadline applies
Format: date-time
idstringRequired within parentUnique identifier of the clearance request
Format: uuid
public_idstringRequired within parentPublic identifier of the clearance request
statusstringRequired within parentCurrent state of the clearance request
Known values: CANCELLED, COMPLETED, DECIDED, PENDING_DECISION, PENDING_QUOTE, PENDING_RETURN

SDK function policy ID: deel.itclearancerequests_listclearancerequests_v2026_09_16. Catalog operation: clearancerequests_listclearancerequests_v2026_09_16. 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: ["it-service-requests:read"]

Pinned headers: {"X-Version": "2026-09-16"}

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.