Skip to main content
GET
Get one approval with what it would send

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

approval_id
string
required

The approval's id, from GET /v1/approvals

Query Parameters

include_html
boolean
default:false

Also return each email's HTML body (html); by default only its plain-text rendering (text)

Response

200 - application/json

Successful Response

app_url
string
required

The approval on the app's Approvals page, where an email shows as it will be sent. When you tell someone about this approval, end your answer with this link so they can review it there

approved_by
ApprovalPerson · object | null
required
approver
ApprovalPerson · object | null
required

The user it is assigned to

content
ApprovalContent · object | null
required

What approving lets through; none for a survey

decided_at
string | null
required

When it was approved or rejected

flow
ApprovalFlow · object
required
id
string
required
kind
enum<string> | null
required

What the step asks to let through: an email, a survey, or a custom approval

Available options:
email,
survey,
basic
playground
boolean
required

A run started from the flow editor's Playground: deciding it only records the decision, and the run continues (or stops) only in the editor that started it, if it is still open

recipients
string[]
required

Who an email or survey goes to

record
ApprovalRecord · object | null
required

The record the run acted on

rejected_by
ApprovalPerson · object | null
required
requested_at
string | null
required

When the run paused for it

run_id
string | null
required

The flow run waiting on it; null for a Playground run (playground)

status
enum<string>
required
Available options:
pending,
approved,
rejected
step_id
string
required

The approval step in the flow

title
string | null
required

An email's subject, or the step's own title