GET List Companies​
GET
/companies
Retrieve a paginated list of companies. Supports sorting, searching, and inline filtering by industry categories and company types. Each company in the response includes the computed contacts_count and the eager-loaded owner relation.
Authorizations​
ApplicationPasswords
WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password
Type
API Key (header: Authorization)
Parameters​
Query Parameters
search
Search companies by name or other searchable fields.
Type
string
sort_by
Column to sort by.
Type
string
Default
"id"sort_order
Sort direction.
Type
string
Valid values
"ASC""DESC"Default
"DESC"inline_filters[company_categories][]
Filter by industry categories.
Type
array
inline_filters[company_types][]
Filter by company types (e.g., partner, customer, vendor).
Type
array
per_page
Number of companies per page.
Type
integer
Default
15page
Page number for pagination.
Type
integer
Default
1Responses​
Paginated list of companies.
application/json
JSON
{
"companies": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"next_page_url": "string",
"prev_page_url": "string",
"from": 0,
"to": 0,
"data": [
{
"id": 0,
"name": "string",
"description": "string",
"email": "string",
"phone": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"type": "string",
"industry": "string",
"logo": "string",
"website": "string",
"linkedin_url": "string",
"facebook_url": "string",
"twitter_url": "string",
"owner_user_id": 0,
"employees_number": 0,
"status": "string",
"contacts_count": 0,
"created_at": "string",
"updated_at": "string",
"owner": {
"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
}
}
]
}
}