File Revisions

List file revisions

Changed on

Shows a file's version history, newest first. People with view access can see the current and earlier published versions. People with edit access can also see drafts.

get/files/{fileId}/revisions

Request

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

Path parameters

fileIdstring required

File ID

Query parameters

statusstring

Choose Draft for work in progress, Finished for the current published version, or Revised for earlier published versions.

_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": "jkBnUsJVEmABoZxtcCRyeQ",
      "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

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      endpoint added