Skip to main content
GET
List allocations
A resource allocation for a member or placeholder.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

startingAfter
string

A cursor ID (uuid) used to request the next page of results. If not provided, defaults to the first page of results.

endingBefore
string

A cursor ID (uuid) used to request the previous page of results. Is mutually exclusive with startingAfter.

limit
integer

The maximum number of results to be returned. Can be any number from 1 to 100. Defaults to 10, if not provided.

modifiedAtAfter

A filter on the list based on the allocation's modifiedAt field. Accepts an ISO 8601 date or datetime. This will match timestamps after (>) the value specified.

modifiedAtOnAfter

A filter on the list based on the allocation's modifiedAt field. Accepts an ISO 8601 date or datetime. This will match timestamps on and after (>=) the value specified.

modifiedAtBefore

A filter on the list based on the allocation's modifiedAt field. Accepts an ISO 8601 date or datetime. This will match timestamps before (<) the value specified.

modifiedAtOnBefore

A filter on the list based on the allocation's modifiedAt field. Accepts an ISO 8601 date or datetime. This will match timestamps on and before (<=) the value specified.

assignmentTypeId
enum<string>

Filter by the assignment type of the allocation. Can be either "project" (Project) or "time_off" (Time Off).

Available options:
project,
time_off
memberId
string

A member ID (uuid) used to filter allocations for a specific member.

projectId
string

A project ID (uuid) used to filter allocations for a specific project.

startBefore
string<date>

A filter on the list based on the allocation's start field in the format YYYY-MM-DD. This will match dates before (<) the date specified.

startOnBefore
string<date>

A filter on the list based on the allocation's start field in the format YYYY-MM-DD. This will match dates on and before (<=) the date specified.

endAfter
string<date>

A filter on the list based on the allocation's end field in the format YYYY-MM-DD. This will match dates after (>) the date specified.

endOnAfter
string<date>

A filter on the list based on the allocation's end field in the format YYYY-MM-DD. This will match dates on and after (>=) the date specified.

Response

200

results
object[]

The list of results for the current page.

hasMore
boolean

Whether there are more results available after this page.