Planned work per project

Returns planned work per project. This endpoint provides the same data that https://use.operating.app/reports/project-portfolio uses as the base of its calculations. To obtain the total planned work, query the entire intended time range; to retrieve only remaining work, query from the current date onward. Grouping and filtering by type of work should be handled by the API consumer.

The response is an array of time blocks of weeks or months as specified by the timeUnit parameter. Each time block contains an array of projects, where each project element details the planned work for that specific time block. Each project object also includes a breakdown of planned work per person within that time block for that project as well as a breakdown of planned work per unnamed position including competence role of the positions.

If the range starts or ends in the middle of a block, the response will include that partial block as a full entry, but with data limited to the specified timeRangeStart and timeRangeEnd parameters.

Pagination is opt-in: pass limit (and optionally after) to page by project. When paginating, the response is { data, meta: { nextCursor } } where data is the usual time-bucket array with only that page of projects in each bucket. Omit limit to keep the legacy bare-array response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string

Only include projects with the given ID.

string

Only include projects with the given client ID.

string

Only include projects with the given tag ID.

string

Only include projects with the given client tag ID.

string

Only include projects with the given site ID.

string

Only include projects with the given group ID.

string

Only include projects with the given status ID.

string

Only include allocations in calculations with the given status ID.

string

For pagination. Return entities after this cursor. Requires limit.

integer
1 to 200

Opt-in pagination. When set, return at most this many people/projects (max 200) and wrap the response as { data, meta }. Omit to keep the legacy bare-array response.

string
enum
required

The unit of time that the timeline will be broken down into.

Allowed:
string

The start of the time range in YYYY-MM-DD. Maximum range of 2 years.

string

The end of the time range in YYYY-MM-DD. Maximum range of 2 years.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json