Get Company (by id)
GET {{base_url}}/company/v2/companies/:companyId
The ‘Get company’ endpoint will return company details for a specific company.
Path variables
| Field | Type | Description |
|---|
| companyId | string | Unique identifier for the company |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique identifier for the company |
| name | string | Name of the company |
| description | string | Description of the company |
| website | string | Company website |
| address | string | Address of the company |
| createdAt | string | Date of creation of the company |
| industry | string | Industry name |
| externalId | string | External ID that a partner may want to use to identify a company |
| crn | string | Companies house number; specific to companies registered with Companies house in the UK |
Error messages
| Condition | Response Status | Response Body |
|---|
| Invalid company id | 404 Not Found | |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
RESPONSES
status: OK
{"id":"CompanyID9890","name":"Company name","description":"Micro SME","website":"www.companyname.com","industry":"IT","address":"London","externalId":"19988-7766","crn":"14455-345","createdAt":"2020-10-28T15:27:15.367Z"}