Resource Requests

Operations for managing resource requests — requests to allocate or hire resources for a project service.

Attributes

booking_method_id integer
Response Parameter `sort` Enum

The booking method ID specifying how the requested time is tracked.

Enum Values (3 values)

  • 1
    Hours per day
  • 2
    Percentage
  • 3
    Total hours
canceled_at string
Response

Timestamp when this resource request was canceled, or null if not canceled.
created_at string
Response Parameter `filter` Parameter `sort`

Timestamp when this resource request was created.
creator person
Response Parameter `sort`

The JSON:API relationship object for the person who created this resource request.
creator_id integer
Parameter `filter`

The ID of the person who created this resource request.
currency string
Response

The currency code used for cost calculations on this resource request.
currency_default object
Response

The default account-level currency code used for cost calculations.
currency_normalized object
Response

The normalized quote-level currency code used for cost calculations.
custom_field_attachments array of attachment
Response

The JSON:API relationship objects for file attachments linked via custom fields.
custom_field_people array of person
Response

The JSON:API relationship objects for people linked via custom fields.
custom_fields object
Response Parameter `filter`

A JSON object containing custom field values for this resource request.
deleted_at string
Parameter `filter`

Timestamp when this resource request was soft-deleted, or null if active.
ended_on string
Response Parameter `filter` Parameter `sort`

The end date of the requested resource allocation period.
exchange_date string
Response

The date used for the exchange rate lookup on this resource request.
exchange_rate number
Response

The exchange rate from the resource request currency to the default account currency.
exchange_rate_normalized number
Response

The exchange rate from the resource request currency to the normalized quote currency.
fields object
Response

A JSON object containing additional structured fields such as job_title, subsidiary_id, team_ids, service_type_ids, and tags.
id integer
Parameter `filter` Parameter `sort`

The unique identifier of this resource request.
job_title string
Parameter `filter`

The requested job title for the resource, as stored in the resource request fields.
max_cost_per_hour object
Response

The maximum cost per hour for the requested resource in the request currency.
max_cost_per_hour_default object
Response

The maximum cost per hour converted to the default account currency.
max_cost_per_hour_normalized object
Response

The maximum cost per hour converted to the normalized quote currency.
note string
Response

An optional HTML note providing additional context for this resource request.
organization organization
Response

The JSON:API relationship object for the organization this resource request belongs to.
percentage integer
Response Parameter `sort`

The requested allocation percentage from 0 to 100 when using percentage-based booking.
query string
Parameter `filter`

A full-text search string used for matching resource requests by title.
rejected_reason string
Response

The reason provided when the resource request was rejected.
resolved_at string
Response Parameter `filter` Parameter `sort`

Timestamp when this resource request was resolved, or null if still open.
resolver person
Response Parameter `sort`

The JSON:API relationship object for the person who resolved this resource request.
resolver_id integer
Parameter `filter`

The ID of the person who resolved this resource request.
service service
Response Parameter `sort`

The JSON:API relationship object for the service this resource request belongs to.
service_id integer
Parameter `filter`

The ID of the service this resource request is associated with.
service_type_id integer
Parameter `filter`

The service type IDs associated with the requested resource, as stored in the fields.
started_on string
Response Parameter `filter` Parameter `sort`

The start date of the requested resource allocation period.
status string
Response Parameter `filter` Parameter `sort` Enum

The current status of the resource request: pending, resolved, rejected, or canceled.

Enum Values (4 values)

  • pending
    Pending
  • resolved
    Resolved
  • rejected
    Rejected
  • canceled
    Canceled
subsidiary_id integer
Parameter `filter`

The subsidiary ID associated with the requested resource, as stored in the fields.
tags string
Parameter `filter`

The list of tag labels associated with this resource request.
team_id integer
Parameter `filter`

The team IDs associated with the requested resource, as stored in the fields.
time integer
Response Parameter `filter` Parameter `sort`

The requested time in minutes per day when using per-day booking.
time_to_close integer
Response Parameter `filter`

The number of minutes elapsed between creation and resolution of this resource request.
title string
Response Parameter `filter`

The title describing the resource being requested.
total_time integer
Response Parameter `sort`

The total requested time in minutes when using total-hours booking.
workplace_id integer
Parameter `filter`

The workplace ID associated with the requested resource, as stored in the fields.

Operations

GET /api/v2/resource_requests
Get resource requests
POST /api/v2/resource_requests
Create a resource request
DELETE /api/v2/resource_requests/{id}
Deletes a resource request
GET /api/v2/resource_requests/{id}
Gets a resource request
PATCH /api/v2/resource_requests/{id}
Update a resource request
PATCH /api/v2/resource_requests/{id}/cancel
Cancel a resource request
PATCH /api/v2/resource_requests/{id}/reject
Reject a resource request
POST /api/v2/resource_requests/{id}/resolve
Resolve a resource request by creating bookings