API ReferenceCompanies
Get a company
Fetches a company, including how many contacts link to it. Requires the `companies:read` scope (`contacts:read` is also accepted for keys issued before it existed).
Authorization
bearerAuth AuthorizationBearer <token>
Workspace API key, e.g. rl_live_….
In: header
Path Parameters
id*string
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/public/companies/string"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "website": "string", "industry": "string", "notes": "string", "externalId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "contactCount": 0}{ "error": "string"}Create a contact POST
Creates a contact. If an existing contact matches the provided identity (e.g. email), it is updated instead. Requires the `contacts:write` scope.
List a company's contacts GET
Contacts linked to the company, most recently active first. Returns full contact records, so it requires `contacts:read` in addition to `companies:read` (`contacts:read` alone is also accepted for keys issued before the companies scopes existed).