Get Companies
GET {{base_url}}/company/v2/companies
The 'Get Companies' endpoint will return a list of all the companies that you have created.
The following details will be returned for the company: - Company id - Name of the company - Date of creation - Registered address - Website - Industry - External ID - Companies house number (CRN)
The companies can be queried by external ID and/or CRN.
Query Parameters
| Field | Type | Description |
|---|---|---|
| pageId | string | Page offset of results |
| 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 |
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 |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageId | null | Page offset of results | |
externalId | null | External ID that a partner may want to use to identify a company | |
crn | null | Companies house number; specific to companies registered with Companies house in the UK |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
X-Api-Key | string | ||
X-Partner-Id | string | ||
Authorization | string |
RESPONSES
status: OK
{"results":[{"id":"CompanyID1234","name":"Company name","description":"Micro SME","website":"www.companyname.com","industry":"IT","address":"London","externalId":"19988-7766","crn":"14455-345","createdAt":"2020-10-21T12:55:09.655Z"}],"links":{}}