Skip to main content
GET
Get approval request

Authorizations

Authorization
string
header
required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Path Parameters

ref
string<uuid>
required

Response

The request

approval_ref
string<uuid>

The request id, as the agent received it.

id
string<uuid>
org_id
string<uuid>
agent_id
string | null

The agent that asked.

agent_version_id
string | null
workflow_id
string<uuid>

The approval workflow routing the decision.

workflow_version_id
string | null

Pinned at capture: a republish never changes an in-flight request.

workflow_run_id
string | null
tool_id
string
tool_name
string

The captured tool, by its agent-facing name.

args
object

The captured arguments — exactly what executes on approval. Never edited.

summary
string | null

The model-written sentence saying what the call does (plain text).

metadata
object

What the model said about the call, outside its arguments: approval_reason (the summary) and progress_message (the line the widget showed while the call ran). Context for the approver; never executed.

requester_user_id
string
requester_run_id
string | null
requester_thread_id
string | null
eligible_user_ids
string[] | null

Who may decide, as the workflow named them; null = any org user but the requester.

ttl_minutes
integer | null
expires_at
string<date-time> | null
status
enum<string>

pending → approved | declined | expired | stale; approved → executed | failed (| stale after a failed dry run).

Available options:
pending,
approved,
declined,
expired,
stale,
executed,
failed
decided_by_user_id
string | null
decided_at
string<date-time> | null
decision_note
string | null
decision_channel
string | null
execution_run_id
string | null
execution_result
any | null

The tool's result when executed.

execution_error
string | null
created_at
string<date-time>
updated_at
string<date-time>