Skip to main content
GET
Get agent scenario

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.

Path Parameters

sid
string
required

ub_sc_ sid or key: interested, meeting_request, info_request, referral, not_now, out_of_office, auto_reply, wrong_person, reschedule_request, cancel_request, other_low_signal, not_interested, objection, do_not_contact, followup_no_reply, signal_followup.

Required string length: 1 - 64

Query Parameters

agent_sid
string

The AI SDR whose scenario it is (ub_ag_…); with a platform key, which agent's version. Left out, the team's default agent.

Required string length: 18
Pattern: ^ub_ag_

Response

get success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
get
item
object
required
included
object
required
includes
string[]
required
meta
object
required