Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Companies

Retrieve a company vendor data

Retrieves a company vendor data with the given the company ID.

See also

Learn more about Filtering, Sorting and Pagination

get/v1/companies/{id}/vendor-data

Path parameters

idstring uuid required

Id of the company

Query parameters

name'pappers' | 'kompany' | 'creditsafe' | 'kyckr' | 'companies_house' | 'inpi' | 'info_camere' | 'transparenzregister' | 'topograph' | 'charity_commission'

Filter items by the name.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

fetched_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the fetched_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

sortstring

Use this parameter to sort query results.
If not specified, sorted in ascending order with values of field fetched_at.
Available fields are fetched_at and name.

pagenumber

Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).

limitnumber

Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 100.

Response

List of vendor data of the company

ℹ️ Click to see full payload

Example response

{
  "pagination": {
    "count": 42
  }
}