List granted companies for a contact (Preview)

Request

List the companies a contact has been granted access to.

A granted company lets the contact read that company's tickets in the customer portal. It is separate from company membership — granting a company does not attach the contact to it, and GET /contacts/{id}/companies does not include grants.

company_ids holds the company_id values you set on your companies, so the list round-trips with the company_ids you send to PUT /contacts/{contact_id}/granted_companies. The list is sorted by company id and paginated.

Returns an empty list when granted companies are not enabled for the workspace.

Requires the read_users_companies OAuth scope. Set Intercom-Version: preview.

Security

bearerAuth

Path

contact_idstringrequired

The unique identifier for the contact which is given by Intercom

Example:63a07ddf05a32042dffac965

Query

pageinteger

The page number to retrieve, starting at 1.

Default:1

Example:page=1

per_pageinteger

The number of company ids to return per page. Values above 150 are reduced to 150.

Default:50

Example:per_page=50

orderstring

The direction to sort the company ids in. Any other value is treated as desc.

Default:"desc"

Enum:"asc""desc"

Example:order=asc

Intercom-Versionstring(intercom_version_preview)

Preview Intercom API version. Used for closed beta endpoints or other features under managed availability.

Default:"preview"

Value:"preview"

Example:preview

curl -i -X GET \
  'https://api.intercom.io/contacts/63a07ddf05a32042dffac965/granted_companies?page=1&per_page=50&order=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: preview'

Responses

Successful

Bodyapplication/json

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

Response

{
  "type": "list",
  "company_ids": [
    "acme-corp",
    "1234"
  ],
  "pages": {
    "type": "pages",
    "next": null,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  },
  "total_count": 2
}