PRprocess
Page Widgets

List page widgets

Returns widgets on a page revision, ordered by position.

get/pages/{pageId}/revisions/{revisionId}/widgets

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/pages/{pageId}/revisions/{revisionId}/widgets
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

pageIdstring required

The ID of the Page

revisionIdstring required

The ID of the Revision

Query parameters

type'CrossLink' | 'Email' | 'Embed' | 'File' | 'FormField' | 'Image' | 'Text' | 'Video'

Filter by widget type.

_string

Opaque pagination cursor. Take this value from the previous response's links[] entry whose name is "next" (typically just follow that link's href instead of reading this value). Omit on the first page. If the previous response had no next link, there are no more pages.

Response

Example response

{
  "data": [
    {
      "id": "qB2llZ1xDP0BoZxtcpJ9iw",
      "taskId": "qB2llZ1xDP0BoZxtcpJ9iw",
      "createdBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "updatedBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "links": [
        {
          "href": "https://api.process.st/api/v1.1/resource/XXX"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.