How does paging work?

There is 3 different headers associated with paging for the projects API. If you go to the developer tools in your browser, and do a ‘GET’ call. You will see in the headers section if you inspect the browser. There is 3 header values:

  • X-Page - the current page being returned
  • X-Pages - the total number of pages available
  • X-Records - the total number of items available

You can request a specific page by calling the same API call and adding the parameter &page=n where n is the page you want. e.g: &page=2 for page 2, &page=5 for page 5.

You will see throughout the calls paging being used to alter the results.

Feedback

If you have any feedback or suggestions, feel free to contact us at api@teamwork.com.