PEpeec
Actions

Get Action

Changed on

One action in full: what to do, the fields the customer owns on it — notes, priority, assignee, due date, tags and repeat — the steps to work through, the content brief when there is one with its sections, the competitor demand behind it, the prompts it affects and the terms competitors use on the topic. A site audit action carries no brief and no opportunity, and its description and steps are the whole fix. An id this project has no published action for is a 404, whether it belongs to another project, to an action type this API does not publish for the project, or to nothing at all. A content optimisation carries its article, suggestions and score on the optimize content endpoint instead.

post/actions/detail

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/actions/detail
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Request body

project_idstring

Required if using a company api key

action_idstring uuid required

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "action_id": "01a0422f-e0c4-7820-85a1-31515a321f15"
}

Response

Success

Example response

{
  "data": {
    "id": "01a0422f-e0c4-7820-85a1-31515a321f15",
    "title": "Add a pricing comparison table to the plans page",
    "category": "EDITORIAL_PITCH",
    "platform": "reddit.com",
    "topic_id": "to_a1b2c3",
    "source": "https://example.com/pricing",
    "domain": "example.com",
    "created_at": "2026-08-20T10:12:00.000Z",
    "due_on": "2026-10-31",
    "page_url": "https://example.com/pricing",
    "steps": [
      {
        "gap_type": "community_phrases"
      }
    ],
    "content_brief_outline": {
      "language": {
        "code": "de",
        "name": "German"
      },
      "outline_points": [
        {
          "evidence": [
            {
              "kind": "winning_source"
            }
          ]
        }
      ]
    }
  }
}

Changes