Pages

List Pages

Changed on

Returns the tree view of custom pages that have been created for this portal. The full tree is returned in one response; this endpoint is not paginated.

get/v3/portals/{portalId}/pages

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/pages
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Query parameters

sortstring

Sorts a collection of portal pages. Supported sort attributes are:

  • created_at
  • updated_at
  • slug
  • title
  • visibility

Filter pages returned in the response.

{
  "created_at": {
    "eq": "2022-03-30T07:20:50Z"
  },
  "updated_at": {
    "eq": "2022-03-30T07:20:50Z"
  }
}

Response

Tree of custom pages in a portal (nested children). Not paginated.

Example response

{
  "data": [
    {
      "id": "437c7192-fea0-4f35-8478-c8d57783f8c1",
      "slug": "/my-page",
      "title": "My Page",
      "visibility": "public",
      "status": "unpublished",
      "description": "A custom page",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "parent_page_id": null,
      "children": []
    }
  ]
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

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

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status