Search companies

Finds companies in the client's workspace from part of their name or domain. Use it to power a search box, or to turn a name someone typed into the company ID the other endpoints need.

For example, {"name": "read"} returns every company whose name contains "read", such as Readmore Labs and Ready Foods, each with its ID, domain, LinkedIn page, LinkedIn handle and logo. Matching ignores upper and lower case. Results are sorted by name from A to Z, 20 by default: set limit (up to 50) to get more or fewer. The search is not paged: if you get exactly limit results, there may be more, so refine name or domain.

Send name, domain, or both. When you send both, a company must match both.

Then use a returned id to get the full company, or as company_ids to find its leads.

Route

POST/api/v3/partner/workspaces/{partner_workspace_id}/companies/query

Path parameters

Parameter	Type	Description
partner_workspace_id	string	Your own ID for the client workspace, as you chose it at creation. URL-encode it in the path.

Body parameters

Parameter	Type	Description
name	string	Case-insensitive substring to match against company names. From 1 to 200 characters.
domain	string	Case-insensitive substring to match against company website domains. From 1 to 200 characters.
limit	integer	Maximum number of matches to return, from 1 to 50. Defaults to 20.

Example request

curl -X POST "https://api.getsillage.com/api/v3/partner/workspaces/ws_123/companies/query" \
  -H "Authorization: Bearer $SILLAGE_MASTER_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "read",
  "limit": 5
}'

Success response

Status: 200 OK

{
  "data": [
    {
      "id": 789,
      "name": "Readmore Labs",
      "domain": "readmorelabs.com",
      "linkedin_url": "https://www.linkedin.com/company/readmore-labs",
      "linkedin_handle": "readmore-labs",
      "logo_url": "https://example.com/readmore-labs.png"
    },
    {
      "id": 812,
      "name": "Ready Foods",
      "domain": "readyfoods.com",
      "linkedin_url": "https://www.linkedin.com/company/ready-foods",
      "linkedin_handle": "ready-foods",
      "logo_url": null
    }
  ]
}

Response fields

This is a capped search, not a page: the answer has no meta.

Field	Type	Description
data[].id	integer	ID of the company in the client's workspace.
data[].name	string or null	Company name.
data[].domain	string or null	Primary domain.
data[].linkedin_url	string or null	LinkedIn company page URL.
data[].linkedin_handle	string or null	LinkedIn company handle.
data[].logo_url	string or null	Logo URL.

Errors

Status	Meaning
401	The master key is missing or invalid.
404	No workspace found for this `partner_workspace_id`.
422	Neither `name` nor `domain` was sent, a value is not valid, or `partner_workspace_id` is invalid.
429	Rate limit exceeded.
500	An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank; code tells one problem from another, detail says what went wrong this time, and errors names the field at fault.