Skip to content
View as Markdown

GET Search Companies​

GET
/companies/search

Search companies by name with a simplified result format (id, name, email, logo, phone, website). Returns up to 50 results sorted by name. Optionally exclude companies already associated with a specific subscriber. Pre-selected company IDs can be passed via values[] to ensure they appear in the results even if they don't match the search.

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 term to filter companies by name.

Type
string
subscriber_id

If provided, exclude companies already associated with this subscriber.

Type
integer
values[]

Array of company IDs that should always be included in results (for pre-selected values in dropdowns).

Type
array

Responses​

Search results.

application/json
JSON
{
"results": [
{
"id": 0,
"name": "string",
"email": "string",
"logo": "string",
"phone": "string",
"website": "string"
}
],
"has_more": true
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI