List Companies
GET /companies
GET
/companies
List companies with optional filtering and pagination.
Authorizations
Parameters
Query Parameters
page
Page number (1-indexed)
integer
Page number (1-indexed)
limit
Items per page (max 200)
integer
Items per page (max 200)
country
state
include_custom_fields
When true, each company includes a custom_fields object of custom column values keyed by column slug. Default false keeps the legacy response shape and adds no extra query.
boolean
When true, each company includes a custom_fields object of custom column values keyed by column slug. Default false keeps the legacy response shape and adds no extra query.
Header Parameters
Responses
200
Successful Response
object
data
required
Array<object>
Lighter company representation for list endpoints.
object
custom_fields
pagination
Any of:
object
has_next
required
Whether there are more pages
boolean
limit
required
Items per page
integer
notes
Any of:
Array<string>
null
page
required
Current page number (1-indexed)
integer
total
required
Total number of items
integer
null
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string