REST API

Written By Lauri EurΓ©n

Last updated 14 days ago

Operating has an open REST API you can find here:

https://operating.readme.io/reference/overview

Pagination on the report endpoints

The four report endpoints can return a lot of data in one response:

  • /v1/reports/people-actual

  • /v1/reports/people-planned

  • /v1/reports/projects-actual

  • /v1/reports/projects-planned

You can ask for the data one page at a time. Add the limit query parameter to set how many people or projects you get per page. The value must be a whole number from 1 to 200.

When you set limit, the response shape changes. Instead of a bare array of time blocks, you get an object with two keys:

  • data β€” the usual array of time blocks, with only that page of people or projects in each block.

  • meta.nextCursor β€” the cursor for the next page. Pass this value in the after query parameter to get the next page. The value is null when there are no more pages.

Pagination is optional. If you leave limit out, the endpoint returns the bare array as before.

The after parameter needs limit. If you send after on its own, the request fails with a validation error.