Skip to main content
POST
Suggest person filter values

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

field
enum<string>
required

Facet field: company_name (the resolved company name) | tag_sids (returns tag sids).

Available options:
company_name,
tag_sids
term
string

Prefix/infix narrowing; omit for top values.

Maximum string length: 64
filter
object

Scope - typically { playtable_sid: { eq: … } }.

limit
integer

1..50, default 20.

Required range: 1 <= x <= 50

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required