Get a list companies

get

https://example.com/onboarding/v2/companies

Used to search for successfully onboarded companies.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

company_number

string

Search by company number

country_code

string

Search by company country code

cursor

string

Define start company ID - used for pagination

date_from

string

Search by transaction creation date - date from - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

date_to

string

Search by transaction creation date - date to - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

external_id

string

Search by company external unique identifier

limit

integer

Define page size - default 25 - used for pagination

name

string

Search by company name

reporting_date_from

string

Reporting date for the transactions summary, it does not filter the companies but the transactions to be included in the summary - reporting date from - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

reporting_date_to

string

Reporting date for the transactions summary, it does not filter the companies but the transactions to be included in the summary - reporting date to - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

sort

string

Define sort order - default ascending

tax_credentials_status

string

Search by status of company tax credentials

tax_number

string

Search by company tax number

transactions_direction

string

Direction of the transactions generated by the company

Responses

401

Authentication failed - missing or incorrect subscription key.

429

Too many requests were sent for a short period of time. Try again a bit later.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok - search finished successfully.

400Bad customer request - any of the provided query parameters is incorrect. See the error response for more details.

5XXInternal server error. Its not you, its us! We are experiencing a rare and unexpected system disruption. Retry again later. The message field of the response will contain more information for the cause. Feel free to contact us.