There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get Contact IDs at a Company

Last updated May 12, 2023

GET /companies/v2/companies/:companyId/vids

Note: This endpoint is deprecated. Use the CRM Associations API to manage company associations.

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Returns all of the contact IDs who have an associatedcompanyid property of :companyid. Useful if you're not looking for any more information on contacts at a company other than that they exist and where to find more information on them.

This will return 100 contacts by default, which is the maximum number of records you can get in a single request. You can get fewer contacts per request using the count= parameter. You can use the "vidoffset": field returned in the results with the vidOffset= parameter to get the next set of results.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Company Id Used in the request URL (see above) Unique identifier for a particular company.
Optional Parameters How to use Description
VidOffset &vidOffset=x - Used in the request URL. The vid to offset the query by.
Count &count=x - Used in the request URL. Specifies the number of contacts to be returned. Supports a maximum value of 600.

If successful the request will return a 200 and an object representing all of the contact IDs associated with a given company.