Skip to main content
GET
/
actions
List action items
curl --request GET \
  --url https://server.promptwatch.com/api/v2/actions \
  --header 'X-API-Key: <api-key>'
{
  "actions": [
    {
      "id": "6ba7b820-9dad-11d1-80b4-00c04fd430c8",
      "projectId": "6ba7b821-9dad-11d1-80b4-00c04fd430c8",
      "type": "SETUP",
      "status": "todo",
      "severity": "high",
      "title": "Connect your sitemap",
      "description": "Add a sitemap so we can crawl your site.",
      "reasoning": "",
      "geoImpact": null,
      "data": {
        "type": "SETUP",
        "setupType": "SITEMAP",
        "status": "NOT_CONFIGURED"
      },
      "completedAt": null,
      "dismissedAt": null,
      "createdAt": "2026-06-01T12:00:00.000Z",
      "updatedAt": "2026-06-01T12:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "size": 50,
  "totalPages": 1
}

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,
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