Get one declared white-label route

GET /v1/developer/white-label-routes/{whiteLabelRoute}

Operation ID: getWhiteLabelRoute

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	Description
`whiteLabelRoute`	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/white-label-routes/{whiteLabelRoute}" \
  --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.
404	The authorized resource was not found.
429	Rate limit or quota exceeded; inspect response metadata before retrying.
503	A required Kismet dependency is temporarily unavailable.

200 response example

{
  "id": "66666666-6666-4666-8666-666666666666",
  "type": "white_label_route",
  "pageType": "PROPERTY_GROUP",
  "host": "www.sandbox-stays.example",
  "servingUrl": "https://www.sandbox-stays.example/groups/waterfront/",
  "path": "/groups/waterfront/",
  "isPrimary": true,
  "entity": {
    "type": "bookable_product_group",
    "id": "44444444-4444-4444-8444-444444444444",
    "slug": "waterfront"
  },
  "customSlug": null,
  "createdAt": "2026-06-01T00:00:00.000Z",
  "updatedAt": "2026-07-01T00:00:00.000Z",
  "links": {
    "self": "/v1/developer/white-label-routes/66666666-6666-4666-8666-666666666666"
  }
}

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": [
    "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"
        }
      }
    }
  }
}