Skip to main content
POST
companies.connections.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
domain
string
required

Company website domain.

categories
enum<string>[]

Relationship categories to match.

Required array length: 1 - 9 elements
Available options:
partner,
vendor,
integration,
investor,
parent,
rebranding,
published_in,
badge,
other
firstSeenFrom
string

First observed after this date.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
firstSeenUntil
string

First observed before this date.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
limit
number

Up to 50 relationships; default 10.

Required range: x >= 1
cursor
string

Opaque nextCursor from the previous page of this exact search.

Required string length: 1 - 1024

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.