Sign in

v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
custom_fields

Fetch custom field

Returns the matching custom field.

get/custom_fields/{custom_field_id}

Response

Successful response

allocation_mode'percent' required

This indicates that a percentage of the resource's time is allocated to the corresponding assignment.

percentnumber required

The percentage of time the resource is allocated to the corresponding assignment.

Note: This property is only present when allocation_mode is "percent".

idinteger

The unique identifier for the assignment.

user_idinteger

The ID of the user this assignment belongs to.

assignable_idinteger

The ID of the project, phase, or leave type to which the the assignment applies.

starts_atstring date required

The assignment's effective start date.

ends_atstring date required

The assignment's effective end date.

repetition_idinteger nullable

A unique identifier for a series of repeating assignments. If the assignment is part of a repeating series, this is the parent assignment's unique ID. Otherwise, it's null.

Note: This ID is the same for all assignments within the same repeating series.

created_atstring date-time

The time of creation.

updated_atstring date-time

The time of the last update.

all_day_assignmentboolean
resource_request_idinteger nullable
bill_ratenumber nullable

The cost value.

bill_rate_idinteger nullable
{"stackTrail":"components:schemas:AssignmentPercentAllocation:allOf:properties:status","oasType":"schema","type":"unknown","nullable":true}
status_option_idinteger nullable

The ID of the status option associated with the assignment.

descriptionstring

Describes the assignment.

noteboolean nullable

Calls out ancillary information about the assignment.

Example response

{
  "allocation_mode": "percent",
  "percent": 0.2,
  "id": 889,
  "user_id": 5612,
  "assignable_id": 1234,
  "starts_at": "2025-09-17",
  "ends_at": "2025-12-17",
  "repetition_id": 886,
  "created_at": "2025-08-27T12:00:00Z",
  "updated_at": "2025-08-27T12:00:00Z",
  "all_day_assignment": true,
  "bill_rate": 100,
  "bill_rate_id": 58776516,
  "status_option_id": 1234567890
}