Companies API: Search

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/companies/search
Handler	OperatelyWeb.Api.Companies.Search

Authentication#

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs#

Field	Type	Required	Nullable	Default
query	string	Yes	No	-

Outputs#

Field	Type	Required	Nullable
results	array of search_result object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/companies/search?query=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "results": [
    {
      "__typename": "value",
      "context": "value",
      "id": "value",
      "matched_field": "title",
      "navigation_target": "<search_navigation_target>",
      "snippet": "value",
      "state": "closed",
      "title": "value",
      "type": "resource_hub_folder"
    }
  ]
}