List declared white-label routes for a manager

GET /v1/developer/collections/{collection}/white-label-routes

Operation ID: listWhiteLabelRoutes

Returns the collection’s declared white-label routes: where each property, group, article, collection listing and singleton page lives on the manager’s own websites. isPrimary marks the canonical page; aliases are returned only with primary=false. Only hosts in the key’s allowed websites are readable, and a publishable key reads only the host of the page making the request. Link an entity only to its declared route; an entity with no route has no page.

Contract status

Field	Value
Maturity	`preview`
Required capability	`white_label_routes.read`
Freshness class	`published-content`
Quota cost	`1`

All operations require a Kismet Developer Bearer credential. Collection and resource authority is resolved from the credential’s installation grants; identifiers in the URL never grant access.

Request parameters

Name	In	Type	Required
`host`	query	string	no
`pageType`	query	PROPERTY \| PROPERTY_GROUP \| BLOG_POST \| COLLECTION \| GROUP_INDEX \| BLOG_INDEX \| HOMEPAGE \| FAQ \| ABOUT \| CONTACT \| OWNER_LANDING \| CUSTOM	no
`vacationRental`	query	string	no
`group`	query	string	no
`article`	query	string	no
`primary`	query	boolean	no
`updatedSince`	query	string	no
`sort`	query	page-type-asc \| entity-slug-asc \| updated-desc \| serving-url-asc	no
`cursor`	query	string	no
`limit`	query	integer	no
`collection`	path	string	yes

Request body

This operation has no JSON request body.

cURL

Set KISMET_API_ORIGIN=https://api.ksmt.app and configure KISMET_DEVELOPER_API_KEY in your environment. Run server-credential requests from your backend, not browser code.

curl --request GET \
  "$KISMET_API_ORIGIN/v1/developer/collections/example-collection/white-label-routes" \
  --header "Authorization: Bearer $KISMET_DEVELOPER_API_KEY" \
  --header "Accept: application/json"

Responses

Status	Meaning
200	Success.
400	Invalid request parameters or body.
401	Missing, invalid, expired, or inappropriate credential/session.
403	Credential lacks the required grant/capability, or an origin/CSRF check failed.
429	Rate limit or quota exceeded; inspect response metadata before retrying.
503	A required Kismet dependency is temporarily unavailable.

200 response example

{
  "data": [
    {
      "id": "55555555-5555-4555-8555-555555555555",
      "type": "white_label_route",
      "pageType": "PROPERTY",
      "host": "www.sandbox-stays.example",
      "servingUrl": "https://www.sandbox-stays.example/rooms/sandbox-chalet/",
      "path": "/rooms/sandbox-chalet/",
      "isPrimary": true,
      "entity": {
        "type": "vacation_rental",
        "id": "22222222-2222-4222-8222-222222222222",
        "slug": "sandbox-chalet"
      },
      "customSlug": null,
      "createdAt": "2026-06-01T00:00:00.000Z",
      "updatedAt": "2026-07-01T00:00:00.000Z",
      "links": {
        "self": "/v1/developer/white-label-routes/55555555-5555-4555-8555-555555555555"
      }
    }
  ],
  "page": {
    "limit": 20,
    "nextCursor": null
  }
}

200 response schema

Content type: application/json. Required fields, nullable values, and nested structures are defined below.

View complete response schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "page"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "type",
          "pageType",
          "host",
          "servingUrl",
          "path",
          "isPrimary",
          "entity",
          "customSlug",
          "createdAt",
          "updatedAt",
          "links"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "white_label_route"
            ]
          },
          "pageType": {
            "type": "string",
            "enum": [
              "PROPERTY",
              "PROPERTY_GROUP",
              "BLOG_POST",
              "COLLECTION",
              "GROUP_INDEX",
              "BLOG_INDEX",
              "HOMEPAGE",
              "FAQ",
              "ABOUT",
              "CONTACT",
              "OWNER_LANDING",
              "CUSTOM"
            ]
          },
          "host": {
            "type": "string"
          },
          "servingUrl": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "isPrimary": {
            "type": "boolean"
          },
          "entity": {
            "type": [
              "null",
              "object"
            ],
            "additionalProperties": false,
            "required": [
              "type",
              "id",
              "slug"
            ],
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "vacation_rental",
                  "bookable_product_group",
                  "article",
                  "collection"
                ]
              },
              "id": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              }
            }
          },
          "customSlug": {
            "type": [
              "null",
              "string"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          },
          "links": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "self"
            ],
            "properties": {
              "self": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "page": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "limit",
        "nextCursor"
      ],
      "properties": {
        "limit": {
          "type": "integer"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    }
  }
}