Skip to content

List Desk Decisions

GET
/desk/decisions

This rep’s pending queue, ranked.

source_group and source are a family/exact pair, not synonyms: source_group=forms matches every form signal, source=form_submitted matches one.

An omitted filter is passed as a real None. The app’s own comment warns that a Query(None) sentinel is TRUTHY and would reach the repository as a filter value - so absent must stay absent all the way down.

Authorizations

Parameters

Query Parameters

decision_type
Any of:
string

Filter by decision type.

source_group
Any of:
string

Filter by signal FAMILY, e.g. “forms” or “website”.

source
Any of:
string

Filter by EXACT signal id, e.g. “form_submitted”.

limit
integer
default: 20 >= 1 <= 50
offset
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A page of decision cards.

object
decisions
Array<object>

One card in the queue: something the desk thinks a rep should do next.

object
created_at
Any of:
string format: date-time
decision_type
Any of:
string
entity_id
Any of:
string
entity_type
Any of:
string
id
Any of:
string
priority
Any of:
number
resolved_at
Any of:
string format: date-time
snoozed_until
Any of:
string format: date-time
source
Any of:
string
source_group
Any of:
string
status
Any of:
string
summary
Any of:
string
title
Any of:
string
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string