Skip to main content
GET
List action items

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

status

Filter by status. Repeat for multiple: status=suggested&status=todo. Pass status=dismissed to fetch dismissed actions.

Available options:
suggested,
dismissed,
todo,
in_progress,
done
type

Filter by action type. Repeat for multiple: type=SETUP&type=CONTENT_GAP

Available options:
WEBSITE_PERFORMANCE,
WEBSITE_HEALTH,
CONTENT_GAP,
SENTIMENT,
REDDIT_SOCIAL,
SETUP,
UNTRACKED_PAGE,
UNTAPPED_PAGE,
OFFSITE_MENTION
severity

Filter by severity. Repeat for multiple: severity=critical&severity=high

Available options:
critical,
high,
medium,
low
size
integer
default:50

Page size (default 50, max 200)

Required range: 1 <= x <= 200
page
integer
default:1

Page number (1-based, default 1)

Required range: x >= 1
startDate
string<date>

Return dismissed actions dismissed on or after this date (YYYY-MM-DD, UTC). Only applied when status=dismissed. Defaults to the last 14 days when omitted.

Response

Default Response

actions
object[]
required

Action items for the project matching the requested filters

total
integer
required

Total actions matching the filters

page
integer
required

Page number (1-based)

size
integer
required

Page size

totalPages
integer
required

Total pages for this page size