Skip to main content
GET
List TPRM Companies

Authorizations

X-API-KEY
string
header
required
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-CONNECTION-ID
string<uuid> | null

Query Parameters

sort
string | null
company_ids
string | null

Filter by company_id (comma-separated list, e.g., 'id_1,id_2')

date_added
string<date-time> | null

Filter by companies date added after this date

domain
string | null

Filter companies by domain (exact match)

updatedSince
string<date-time> | null

Only records whose updated_at is at or after this time. Leen bumps updated_at whenever any field on a record changes, so this is the filter for an incremental sync: it returns records that are new and records that changed, and nothing that has stood still. Example: 2021-01-01T00:00:00+00:00.

Example:

"2021-01-01T00:00:00+00:00"

cursor
string | null

Opaque position of the next page, taken from the previous response. Ignore its contents; it encodes where the walk had reached.

limit
integer
default:100

How many records to return per page. The walk is the same either way; a larger page means fewer round trips and more memory per response.

Required range: 1 <= x <= 500

Response

Successful Response

items
TPRM Company · object[]
required

The records on this page.

next_cursor
string | null

Opaque position of the next page. Pass it back as cursor to continue; null when this is the last page.

previous_cursor
string | null

Opaque position of the previous page, for walking backwards. Null on the first page.