Skip to main content
POST
Search activity objects

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_activity_objects.

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:
person,
company,
play_acts,
person_journey
page_size
integer

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

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

pagination.next_cursor of the previous page.

fresh
object

A second filter with the same leaves that marks facts inside filter (a fact is fresh when both keep it): "new since I looked" is created_at {gt: seen_at} with occurred_at {gt: seen_at minus three days}. No leaf marks nothing.

fresh_objects
enum<string>

only = list the objects holding a fresh fact; without = list the objects holding none. Absent lists every object. With no fresh, only lists nothing.

Available options:
only,
without

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