Allocations Report

get

https://api.operating.app/v1/reports/allocations

Returns allocations with details about the associated clients, projects and people included.

Allocations represent a confirmed or planned investment of time for a given duration.

Each allocation belongs to a single position in a single project. The position can have an assigned person and an assigned role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

createdBefore

string

Filter records by whether they were created before a certain instant in ISO8601 format in UTC.

createdSince

string

Filter records by whether they were created after a certain instant in ISO8601 format in UTC.

updatedBefore

string

Filter records by whether they were updated before a certain instant in ISO8601 format in UTC.

updatedSince

string

Filter records by whether they were updated after a certain instant in ISO8601 format in UTC.

archived

boolean

If true, includes only archived allocations. If false, includes only non-archived allocations. If omitted, both archived and non-archived allocations are included.

fromAfter

string

Only return allocations with a from date after the given date in YYYY-MM-DD.

fromBefore

string

Only return allocations with a from date before the given date in YYYY-MM-DD.

updated_since

string

DEPRECATED Use updatedSince instead. Only return allocations that have been updated since the given instant in ISO8601 format in UTC.

splitByTimeOff

boolean

If true, splits the allocations by time off. When the allocations are split, several rows can be returned for each actual allocation. If false, returns the allocations as they are. Defaults to false.

throughAfter

string

Only return allocations with a through date after the given date in YYYY-MM-DD.

throughBefore

string

Only return allocations with a through date before the given date in YYYY-MM-DD.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Invalid input data

401Authorization not provided

403Insufficient access

404Not found

500Internal server error