page
as a get parameter to access the other pages.example:
# Get the second page of results for the Inbox index action. /inbox/index?page=2
Use HTTP Response Headers for pagination:
Header | Description |
---|---|
X-Pagination-Current-Page | The current page. Defaults to 1. |
X-Pagination-Page-Count | The total number of pages in the result set. Use this along with X-Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved. |
X-Pagination-Total-Count | The total number of records. |
X-Pagination-Per-Page | The count records of page |
Other valid solution is using the Link header introduced by RFC 5988.
Link: <inbox/index?access_token=xxx&page=1&per-page=100>; rel=self, <....> ; rel=first, .......
Content-Type | Accept | |
---|---|---|
JSON | application/json | application/json |
XML | application/xml | application/xml |
XML & JSON. The used format depends on the passed header in the request.
The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
All dates and times are in (GMT -5:00) Eastern Standard Time (EST) and the following format: YYYY-MM-DD HH:MM:SS
More information on how to obtain your access token is available here: API Getting Started »