List True Companies in a Collection

get

https://platform.beauhurst.com/_api/v2.0/truecompany/collection/{collection_id}

    Use a True Company Collection ID to find the True Companies in the Collection.
    Filter to see which have been added to the collection or have been modified recently.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

collection_id

string

required

Beauhurst True Company Collection ID

Query Params

added_to_collection_since

date-time

Filter to memberships added since this datetime (ISO-8601 format)

limit

integer

Number of results to return per page.

modified_since

date-time

Filter to True Companies modified since this datetime (ISO-8601 format)

offset

integer

The initial index from which to return the results.

sort

string

enum

length ≥ 1

Sort by name, company_registration_number, registration_date or last_modified_date. Prefix with '-' for descending order.

name - name
-name - -name
company_registration_number - company_registration_number
-company_registration_number - -company_registration_number
registration_date - registration_date
-registration_date - -registration_date
last_modified_date - last_modified_date
-last_modified_date - -last_modified_date

Response

200