Skip to content
Home/
REST API Reference
/
/
Granted Company List

Granted Company List

A list of the company ids a contact has been granted access to.

typestring

The type of object

Value:"list"
Example:"list"
company_idsArray of strings

The company_id values of the companies the contact has been granted access to.

Example:
[
  "acme-corp"
]
pagesobject or null(Pagination Object)

Pagination details. Null on the replace response, which returns the whole stored set.

total_countinteger

The total number of companies the contact has been granted access to.

Example:2
{
  "type": "list",
  "company_ids": [
    "acme-corp"
  ],
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  },
  "total_count": 2
}