PRproductive
Pages

Gets a public doc

Changed on

Returns a published doc. The response carries a reduced attribute set and includes the doc's child_pages, ordered by position.

get/api/v2/public/pages/{uuid}

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/public/pages/{uuid}
  • Auth
    none required

Path parameters

uuidstring required

The public UUID of the doc (public_uuid).

Response

A published doc as seen without authentication: a reduced attribute set plus its child_pages.

Example response

{
  "data": {
    "id": "48213",
    "type": "pages",
    "attributes": {
      "title": "Onboarding guide",
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Welcome to the onboarding guide.\"}]}]}",
      "cover_image_meta": null,
      "cover_image_url": null,
      "icon_id": "book",
      "position": null,
      "preferences": {},
      "public_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "relationships": {
      "child_pages": {
        "data": [
          {
            "type": "pages",
            "id": "48214"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "48214",
      "type": "pages",
      "attributes": {
        "title": "Week one",
        "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Welcome to the onboarding guide.\"}]}]}",
        "cover_image_meta": null,
        "cover_image_url": null,
        "icon_id": null,
        "parent_page_id": 48213,
        "position": 1,
        "preferences": {},
        "root_page_id": 48213
      }
    }
  ],
  "meta": {}
}

Changes

  • fa3060fd0144Revision changes
    • info

      added the media type application/vnd.api+json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • f11a8740641aRevision changes
    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from integer to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • info

      added to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      removed subschema #1: Collection data from the // response property anyOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    This list may be incomplete.