Skip to content

Deel: Get Hourly Report Root Presets

Deel projects.getHourlyReportRootPresets: arguments, response, policy and SDK examples.

← Projects operations · Get started

Operation deel.projects_gethourlyreportrootpresets_v2026_01_01

Provider route: GET /timesheets/root-presets. 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["projects"]["getHourlyReportRootPresets"]>[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.projects.getHourlyReportRootPresets(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.projects.get_hourly_report_root_presets(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 10
Maximum: 100
query.order_bystringOptionalDefault: created_at
One of: created_at
query.order_directionstringOptionalDefault: DESC
One of: ASC, DESC
query.work_statement_statusesarrayOptionalDefault: [“ACTIVE”, “PENDING”, “INITIAL”]
query.work_statement_statuses[]stringEach item
query.cursorstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Hourly Report Root Presets — 200 response body

Referenced models: Get Hourly Report Root Presets — 200 response body

Get Hourly Report Root Presets — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get Hourly Report Root Presets — 200 response body — data item
pageModelRequired within parentExpand Get Hourly Report Root Presets — 200 response body — page

Referenced models: Get Hourly Report Root Presets — 200 response body — data item, Get Hourly Report Root Presets — 200 response body — page

Get Hourly Report Root Presets — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
contracts_countJSONRequired within parent
contracts_count (anyOf 1)integerAlternativeNumber of contracts using this root preset
contracts_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
descriptionstringRequired within parentDetailed description of the hourly report root preset
fileJSONOptional
file (anyOf 1)ModelAlternativeExpand Get Hourly Report Preset by ID — 200 response body — data file id, name, type
file (anyOf 2)nullAlternative
hourly_report_presets_countJSONRequired within parent
hourly_report_presets_count (anyOf 1)integerAlternativeNumber of hourly report presets created from this root preset
hourly_report_presets_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe unique identifier of the hourly report root preset
Format: uuid
titlestringRequired within parentThe title of the hourly report root preset
typestringOptionalThe type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate
Known values: RATE, TRACKING

Referenced models: Get Hourly Report Preset by ID — 200 response body — data file id, name, type

Get Hourly Report Root Presets — 200 response body — page
FieldTypePresenceDescription and constraints
$objectRoot
cursorstringRequired within parentPagination cursor for fetching the next set of results
total_rowsJSONRequired within parent
total_rows (anyOf 1)integerAlternativeTotal number of root presets available
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Get Hourly Report Preset by ID — 200 response body — data file id, name, type
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file
typestringOptionalThe type of the file

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

Required provider scopes: ["timesheets:read"]

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.