Skip to main content
POST
Search companies

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of search_companies.

filter
object

Field filters, ANDed: {field: {eq | ne | in | nin | gte | lte | gt | lt | is_null}}; q inside it is free text. Omit for every row.

include
enum<string>[]

Relations to attach to every item; omit for the bare rows.

Available options:
people_counts,
field_values,
last_activities,
notes,
signals,
freshness
sort
object

One sort column with its direction; default row_order asc, the grid row order (a per-team arrival sequence, never a job title).

page_size
integer

0..500, default 50; 0 = counts only, 1 = the first row.

Required range: 0 <= x <= 500
cursor
string | null

pagination.next_cursor of the previous page.

filter_ast
any

The §4.18 filter AST (the same tree the grid saves on a view): ANDed with filter; typed leaves over object attributes, record. cells, journey arrays, and the signals leaf (any of the catalog names the account carries).

sids_only
boolean

Answer the matching sids only (the grid's ids-only model): items carry {sid} and nothing else.

semantic
object

Semantic search over one embedded column (research §Filterable, the I5 engine); the result order is similarity.

Response

search success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
search
items
object[]
required
pagination
object
required
applied_filters
object
required
includes
string[]
required
meta
object
required
counts
object