Skip to content
Home/
REST API Reference
/
/
Companies

Companies

This will return a list of companies for the App. On the last page, pages.next is null.

typestring

The type of object - list.

Value:"list"
Example:"list"
pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

total_countinteger

The total number of companies.

Example:100
dataArray of objects(Company)

An array containing Company Objects.

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "prev": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  },
  "total_count": 100,
  "data": [
    { … }
  ]
}