`approvals`

Open an operation to see its authentication, its parameters and the fields of its request and response.

1 operation

GET`/v1/approvals`

Drafts to send, fixes to approve, escalations and release proposals, oldest first.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/approvals
Name	Type	Description
`cursor`query	`string`
`limit`query	`integer`
`kind`query	`array of enum`
`workspace_id`query	`string`
`sort`query	`enum`	Values `oldest \| sla \| newest`

Response `200`

Response, GET /v1/approvals
Name	Type	Description
`items`required	`array of object`
`items[].kind`required	`enum`	Values `draft \| fix \| escalation`
`items[].ticket`required	`object`
`items[].ticket.id`required	`string`
`items[].ticket.org_id`required	`string`
`items[].ticket.workspace_id`required	`string`
`items[].ticket.workspace_name`required	`string`
`items[].ticket.client_name`required	`string`
`items[].ticket.channel_id`required	`string`
`items[].ticket.origin`required	`enum`	Values `email \| widget \| github \| proactive`
`items[].ticket.external_id`required	`string`
`items[].ticket.customer_email`required	`string`
`items[].ticket.customer_name`required	`string`
`items[].ticket.subject`required	`string`
`items[].ticket.state`required	`enum`	Values `received \| triage \| needs_info \| draft_ready \| answered \| fixing \| awaiting_approval \| releasing \| customer_notified \| closed \| escalated`
`items[].ticket.public_state`required	`enum`	Values `in_analysis \| needs_reply \| answered \| fix_in_progress \| releasing \| resolved \| team_review`
`items[].ticket.category`required	`enum`	Values `usage \| config \| docs \| bug \| feature_request \| unknown`
`items[].ticket.priority`required	`enum`	Values `low \| normal \| high \| urgent`
`items[].ticket.assignee_user_id`required	`string`
`items[].ticket.github_item_kind`required	`enum`	Values `issue \| pull_request`
`items[].ticket.github_number`required	`integer`
`items[].ticket.labels`required	`array of string`
`items[].ticket.language`required	`string`
`items[].ticket.is_demo`required	`boolean`
`items[].ticket.demo`required	`boolean`
`items[].ticket.error_group_id`required	`string`
`items[].ticket.duplicate_of_ticket_id`required	`string`
`items[].ticket.resolved_version`required	`string`
`items[].ticket.latest_confidence`required	`number`
`items[].ticket.needs_team_action`required	`boolean`
`items[].ticket.message_count`required	`integer`
`items[].ticket.last_message_at`required	`string (date-time)`
`items[].ticket.first_response_at`required	`string (date-time)`
`items[].ticket.released_at`required	`string (date-time)`
`items[].ticket.closed_at`required	`string (date-time)`
`items[].ticket.last_customer_message_at`required	`string (date-time)`
`items[].ticket.sla_due_at`required	`string (date-time)`
`items[].ticket.reopened_count`required	`integer`
`items[].ticket.created_at`required	`string (date-time)`
`items[].ticket.updated_at`required	`string (date-time)`
`items[].waiting_since`required	`string (date-time)`
`items[].draft`required	`object`
`items[].draft.id`required	`string`
`items[].draft.kind`required	`enum`	Values `reply \| needs_info \| interim \| release_notice \| proactive_notice`
`items[].draft.excerpt`required	`string`
`items[].draft.language`required	`string`
`items[].fix`required	`object`
`items[].fix.id`required	`string`
`items[].fix.attempt_number`required	`integer`
`items[].fix.pr_number`required	`integer`
`items[].fix.pr_url`required	`string (uri)`
`items[].fix.head_sha`required	`string`
`items[].fix.status`required	`enum`	Values `prepared \| proposed`
`items[].fix.verified_by`required	`enum`	Values `harness \| agent \| server`
`items[].fix.tests_passed`required	`boolean`
`items[].fix.diff_stats`required	`object`
`items[].fix.diff_stats.files_changed`required	`integer`
`items[].fix.diff_stats.additions`required	`integer`
`items[].fix.diff_stats.deletions`required	`integer`
`items[].reason`required	`string`
`items[].sla_breached`required	`boolean`
`next_cursor`required	`string`
`releases`required	`array of object`
`releases[].id`required	`string`
`releases[].org_id`required	`string`
`releases[].workspace_id`required	`string`
`releases[].repository_id`required	`string`
`releases[].tag`required	`string`
`releases[].version`required	`string`
`releases[].sha`required	`string`
`releases[].merged_sha`required	`string`
`releases[].status`required	`enum`	Values `proposed \| approved \| merging \| tagged \| ci_running \| succeeded \| failed`
`releases[].ci_status`required	`enum`	Values `pending \| running \| success \| failure \| none`
`releases[].changelog_md`required	`string`
`releases[].public_notes_md`required	`string`
`releases[].ticket_ids`required	`array of string`
`releases[].github_release_id`required	`integer`
`releases[].ci_run_ids`required	`array of integer`
`releases[].approval_id`required	`string`
`releases[].approved_by_user_id`required	`string`

Name

Type

Description

cursorquery

string

limitquery

integer

kindquery

array of enum

workspace_idquery

string

sortquery

enum

Values oldest | sla | newest

Name

Type

Description

itemsrequired

array of object

items[].kindrequired

enum

Values draft | fix | escalation

items[].ticketrequired

object

items[].ticket.idrequired

string

items[].ticket.org_idrequired

string

items[].ticket.workspace_idrequired

string

items[].ticket.workspace_namerequired

string

items[].ticket.client_namerequired

string

items[].ticket.channel_idrequired

string

items[].ticket.originrequired

enum

Values email | widget | github | proactive

items[].ticket.external_idrequired

string

items[].ticket.customer_emailrequired

string

items[].ticket.customer_namerequired

string

items[].ticket.subjectrequired

string

items[].ticket.staterequired

enum

Values

received | triage | needs_info | draft_ready | answered | fixing | awaiting_approval | releasing | customer_notified | closed | escalated

items[].ticket.public_staterequired

enum

items[].ticket.categoryrequired

enum

items[].ticket.priorityrequired

enum

Values low | normal | high | urgent

items[].ticket.assignee_user_idrequired

string

items[].ticket.github_item_kindrequired

enum

Values issue | pull_request

items[].ticket.github_numberrequired

integer

items[].ticket.labelsrequired

array of string

items[].ticket.languagerequired

string

items[].ticket.is_demorequired

boolean

items[].ticket.demorequired

boolean

items[].ticket.error_group_idrequired

string

items[].ticket.duplicate_of_ticket_idrequired

string

items[].ticket.resolved_versionrequired

string

items[].ticket.latest_confidencerequired

number

items[].ticket.needs_team_actionrequired

boolean

items[].ticket.message_countrequired

integer

items[].ticket.last_message_atrequired

string (date-time)

items[].ticket.first_response_atrequired

string (date-time)

items[].ticket.released_atrequired

string (date-time)

items[].ticket.closed_atrequired

string (date-time)

items[].ticket.last_customer_message_atrequired

string (date-time)

items[].ticket.sla_due_atrequired

string (date-time)

items[].ticket.reopened_countrequired

integer

items[].ticket.created_atrequired

string (date-time)

items[].ticket.updated_atrequired

string (date-time)

items[].waiting_sincerequired

string (date-time)

items[].draftrequired

object

items[].draft.idrequired

string

items[].draft.kindrequired

enum

Values reply | needs_info | interim | release_notice | proactive_notice

items[].draft.excerptrequired

string

items[].draft.languagerequired

string

items[].fixrequired

object

items[].fix.idrequired

string

items[].fix.attempt_numberrequired

integer

items[].fix.pr_numberrequired

integer

items[].fix.pr_urlrequired

string (uri)

items[].fix.head_sharequired

string

items[].fix.statusrequired

enum

Values prepared | proposed

items[].fix.verified_byrequired

enum

Values harness | agent | server

items[].fix.tests_passedrequired

boolean

items[].fix.diff_statsrequired

object

items[].fix.diff_stats.files_changedrequired

integer

items[].fix.diff_stats.additionsrequired

integer

items[].fix.diff_stats.deletionsrequired

integer

items[].reasonrequired

string

items[].sla_breachedrequired

boolean

next_cursorrequired

string

releasesrequired

array of object

releases[].idrequired

string

releases[].org_idrequired

string

releases[].workspace_idrequired

string

releases[].repository_idrequired

string

releases[].tagrequired

string

releases[].versionrequired

string

releases[].sharequired

string

releases[].merged_sharequired

string

releases[].statusrequired

enum

releases[].ci_statusrequired

enum

Values pending | running | success | failure | none

releases[].changelog_mdrequired

string

releases[].public_notes_mdrequired

string

releases[].ticket_idsrequired

array of string

releases[].github_release_idrequired

integer

releases[].ci_run_idsrequired

array of integer

releases[].approval_idrequired

string

releases[].approved_by_user_idrequired

string

GET/v1/approvals

Parameters

Response 200

GET/v1/approvals

Parameters

Response 200

GET`/v1/approvals`

Response `200`

GET`/v1/approvals`

Response `200`