v1Resources/Approvals/getList approvals

List approvals

Lists approvals, newest first. By default it returns the ones still waiting for a decision. Each shows what it would change, who decided and why, and whether an approved item published.

get/api/v1/approvals
approvals:read
Query parameters
statusstring (pending | approved | rejected | all)optional
Which approvals to list: pending (the default), approved, rejected or all.
clientIdstringoptional
Only this client's approvals.
limitintegeroptional
How many to return, 1 to 200. The default is 50.
offsetintegeroptional
How many to skip, for paging.
Response
dataarray of objectoptional
idstringoptional
statusstring (pending | approved | rejected)optional
kindstringoptional
What kind of item this is, for example content your agent drafted or an action held by your autonomy rules.
originstringoptional
titlestringoptional
summarystringoptional
clientIdstringoptional
modulestringoptional
changeobjectoptional
The exact action that runs on approval: the tool, its arguments and the fields it changes.
toolstringoptional
argsobjectoptional
fieldsarray of objectoptional
contentobjectoptional
The drafted content, when the item is content.
requestedAtstringoptional
scheduledForstringoptional
expiresAtstringoptional
decidedAtstringoptional
decidedBystringoptional
Who made the decision, or null while it is still pending.
decisionReasonstringoptional
publishStatestring (published | failed)optional
publishErrorstringoptional
publishedAtstringoptional
totalintegeroptional
limitintegeroptional
offsetintegeroptional
hasMorebooleanoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/approvals
Your API key
status
clientId
limit
offset
{}

New to the Synup API?