Skip to content
Home/
REST API Reference
/
/
Company Users

Company Users

The contacts attached to one company, returned when type is user or users and the request names a single company. Contacts are in the legacy user format. On the last page, pages.next is null.

typestring

The type of object - user.list.

Value:"user.list"
Example:"user.list"
usersArray of objects

The contacts attached to the company, in the legacy user format.

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 contacts attached to the company.

Example:1
limitedboolean

Always false for this list.

Example:false
{
  "type": "user.list",
  "users": [
    {}
  ],
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "prev": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  },
  "total_count": 1,
  "limited": false
}