Skip to content

List Companies Enriched

GET
/companies/enriched

Companies with their revenue and account overlays joined on.

GET /companies returns the base record. This returns the same companies with the ABM and revenue overlay fields - tier, score, owner, status - coalesced in, which is what the account views are built from.

Authorizations

Parameters

Query Parameters

skip

Rows to skip.

integer

Rows to skip.

limit

Rows to return. The app defaults this to 10000 - the entire roster in one response. Defaulted to 100 here; raise it deliberately.

integer
default: 100 >= 1 <= 10000

Rows to return. The app defaults this to 10000 - the entire roster in one response. Defaulted to 100 here; raise it deliberately.

search
Any of:
string

Substring match on name or domain.

status
Any of:
string

Filter by record status, e.g. prospect.

website_status
Any of:
string

Filter by website status.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string