Skip to content

The approval inbox: approvers see every request, authors their own

GET
/api/v1/workspaces/{workspace}/approvals
curl --request GET \
--url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/approvals?status=pending&days=30' \
--header 'Authorization: Bearer <token>'

Permission: campaigns:view

workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

status
string
default: pending
Allowed values: pending approved changes_requested rejected invalidated all
author

Requester user id

string

Requester user id

approver

Approver user id

string

Approver user id

days

Requested in the last N days (0: all)

integer format: int64
default: 30 <= 3650

Requested in the last N days (0: all)

OK

Media typeapplication/json
object
allRequests
required
boolean
approvers
required
Array<object>
object
id
required
string
name
required
string
authors
required
Array<object>
object
id
required
string
name
required
string
canManage
required
boolean
counts
required
object
all
required
integer format: int64
approved
required
integer format: int64
changesRequested
required
integer format: int64
invalidated
required
integer format: int64
pending
required
integer format: int64
rejected
required
integer format: int64
items
required
Array<object>
object
audience
required
integer format: int64
audienceNow
integer format: int64
author
required
object
color
required
string
email
required
string
id
required
string
initials
required
string
name
required
string
presence
string
role
required
string
automationId
string
campaignId
string
channel
required
string
Allowed values: email sms push whatsapp
decidedAt
string format: date-time
decidedBy
string
id
required
string
name
required
string
note
string
page
object
name
required
string
pageId
required
string
path
required
string
publishAt
string format: date-time
published
required
boolean
slug
required
string
template
required
string
visibility
required
string
Allowed values: public members paid
visibilityLabel
required
string
when
required
string
Allowed values: now at
requestedAt
required
string format: date-time
route
required
string
rules
required
string
scheduleAt
string format: date-time
scheduleMode
required
string
Allowed values: now at best_time
sentAt
string format: date-time
status
required
string
Allowed values: pending approved changes_requested rejected invalidated bypassed sent cancelled
subjectType
required
string
Allowed values: campaign automation transactional_template website_post website_page
transactionalTemplateId
string
website
object
excerpt
required
string
kind
required
string
Allowed values: campaign web
path
required
string
postId
required
string
publishAt
string format: date-time
published
required
boolean
slug
required
string
title
required
string
visibility
required
string
Allowed values: public members paid
visibilityLabel
required
string
when
required
string
Allowed values: now at with_send
websitePageId
string
websitePostId
string
policy
required
object
approvalsRequired
required
integer format: int64
approvers
required
Array<string>
medianWaitMinutes
integer format: int64
rules
required
Array<string>

Example

{
"items": [
{
"channel": "email",
"page": {
"visibility": "public",
"when": "now"
},
"scheduleMode": "now",
"status": "pending",
"subjectType": "campaign",
"website": {
"kind": "campaign",
"visibility": "public",
"when": "now"
}
}
]
}

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example

{
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}