Skip to main content
GET
/
v1
/
entities
/
search
Search entities
curl --request GET \
  --url https://api.getsteerco.com/v1/entities/search \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Workspace-Id: <x-workspace-id>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "metadata": {}
  }
]

Authorizations

​
Authorization
string
header
required

API key (ak_ prefix). Generate one from your Steerco profile settings.

Headers

​
X-Workspace-Id
string
required

The workspace ID. Get available workspaces from GET /v1/workspaces.

Query Parameters

​
query
string
required

Search query to find matching entities

​
type
string

Optional entity type filter (e.g. 'account', 'contact')

Response

200 - application/json

List of matching entities

​
id
string
required
​
name
string
required
​
type
string
required
​
metadata
object
required