| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The Search API allows you to discover companies in the Veridion database, by passing in a set of Search Filters.
Required fields
Ensure that your payload contains a filters field, which is mandatory.
This field should include exactly one wrapper operator (and/or) followed by one or more search filters, as detailed below.
Filter structure and syntax
Within the filters field, every filter must include the base elements listed below:
| Field | Definition | Example |
|---|---|---|
attribute | The specific company-related property or attribute to be filtered, such as company name, location, etc. See the full filter list. | company_naics_code |
relation | The type of comparison or logical operation applied between the attribute and value (e.g. You can find the full list of available relations under the Search filter relations section. | equals |
value | The reference data or criteria that the attribute should meet, based on the specified relation. | 541512 |
Search queries & filtersFor more information on structure and required fields, please consult the How to build a Search Query and Search filters sections.
Paginated requests
Pagination can be controlled via the page_size and pagination_token query parameters. Pagination tokens can be retrieved from the response pagination object, present when the response is successful.
Responses
Paginated endpoints will return the following response fields.
| Field | Type | Description |
|---|---|---|
pagination | object | Holds next and previous tokens for navigation between pages. |
count | integer | Total number of results for the current request. |
result | object array | The list of results for the requested page. |
The pagination object contains the below fields.
| Field | Type | Description |
|---|---|---|
next | string (optional) | Should be used to retrieve the next page of results. |
previous | string (optional) | Should be used to retrieve the previous page of results. |
null pagination tokenNote that
nextorpreviouspagination tokens may benull, depending on the presence of remaining results to retrieve. For instance, when retrieving the first page, theprevioustoken will benullsince there are no previous pages.
How to issue paginated requests
Each paginated endpoint accepts the following query parameters:
| Parameter | Type | Description |
|---|---|---|
page_size | integer (optional) | Number of results to be returned per page. Default value: 10. Maximum value: 200. |
pagination_token | string (optional) | Either next or previous token value, depending on whether you want to retrieve the previous or the next page. This value should be treated as opaque. Defaults to undefined, which returns results from the beginning of the list. |
Pagination sessionsPlease be aware that once you start a pagination session (i.e., the navigation between pages is ongoing), the API will generate an error if you try to modify any of the request parameters or the request body itself.
If you need to reset your request, simply remove the
pagination_tokenparameter.
Successful responses
When the request is successful, a standard 200 OK HTTP status will be sent along with the expected JSON.
The response will include the following fields:
pagination- object that holds thenextandprevioustokens for navigation between pages.count- the total number of results for the current request.result- the list of results for the requested page.
Response datapointsFor a comprehensive list of all data points returned and additional information, please refer to the Response Fields and Types page.
Error responses
If the request is unsuccessful, the API will return one of the below HTTP status responses:
400 Bad Request, if the input lacks the required fields or structure detailed above.- other standard HTTP error responses, detailed in the Response codes section.
Any error response follows a specific structure. Please see the Error response format section for more details.