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

Company Scroll

Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.

typestring

The type of object - list

Value:"list"
Example:"list"
dataArray of objects(Company)
pagesobject or null

Always null. Page through a scroll with scroll_param instead.

total_countinteger or null

Always null. The scroll endpoint does not count the companies it returns.

scroll_paramstring

The scroll parameter to use in the next request to fetch the next page of results.

Example:"25b649f7-4d33-4ef6-88f5-60e5b8244309"
{
  "type": "list",
  "data": [
    { … }
  ],
  "pages": {},
  "total_count": 0,
  "scroll_param": "25b649f7-4d33-4ef6-88f5-60e5b8244309"
}