Search for a company
GET https://api.company-information.service.gov.uk/alphabetic-search/companies
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| q | string | The company name being searched for |
Required |
| search_above | string | The ordered_alpha_key_with_id used for paging |
|
| search_below | string | The ordered_alpha_key_with_id used for paging |
|
| size | string | The maximum number of results matching the search term(s) to return with a range of 1 to 100 |
This request requires the use of one of following authorisation methods:
API key
.
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK A list of companies |
List of companies |
| 404 | Not Found No companies found |
|
| 422 | Invalid size parameter, size must be greater than zero and not greater than 100 |