Deel: List time-off requests

← time_off operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.timeoff_gettimeoffprofile

Provider route: GET /time_offs/profile/{hris_profile_id}. Alter supplies the connection’s credentials and routing.

Call through Alter

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["timeOff"]["getTimeOffProfile"]>[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.timeOff.getTimeOffProfile(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.time_off.get_time_off_profile(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.hris_profile_id	string	Required within parent	Format: uuid
query	object	Optional	Additional keys: not allowed
query.status	array	Optional
query.status[]	string	Each item	One of: REQUESTED, APPROVED, REJECTED, USED, CANCELED
query.time_off_ids	array	Optional
query.time_off_ids[]	string	Each item	Format: uuid
query.start_date	string	Optional	Format: date-time
query.end_date	string	Optional	Format: date-time
query.approval_start_date	string	Optional	Format: date-time
query.approval_end_date	string	Optional	Format: date-time
query.updated_start_date	string	Optional	Format: date-time
query.updated_end_date	string	Optional	Format: date-time
query.page_size	integer	Optional	Maximum: 200 Minimum: 5
query.policy_types	array	Optional
query.policy_types[]	string	Each item	Format: uuid
query.policy_type_names	array	Optional
query.policy_type_names[]	Model	Each item	Expand List policies — request body — query policy type name
query.next	string	Optional

Referenced models: List policies — request body — query policy type name

Response

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

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List time-off requests — 200 response body

Referenced models: List time-off requests — 200 response body

Policy, approvals and errors

SDK function policy ID: deel.timeoff_gettimeoffprofile. Catalog operation: timeoff_gettimeoffprofile. 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: ["time-off:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source