/bff/routing/list

Returns a paginated routing table for the authenticated organisation. Supports filtering by entity type, entity ID, slug, canonical status, and locale. Routes are ordered by insertion date (newest first).

RoutinggetBffRoutingList

Parameters

7 query

7 total

Query · 7

typeCodestring

Filter by route type code (e.g. "article", "product-detail").

relatedEntityIdstring

Filter by related entity ID. Accepts internal numeric ID or external ID (e.g. "P93gIby6q5t2gi2a"). When using external ID, typeCode must also be provided for correct resolution.

slugstring

Filter by slug (partial match, case-insensitive).

canonicalstring

Filter by canonical status ("true" or "false").

localestring

Filter by locale code (e.g. "cs", "en").

pagestring

Page number (1-based). Default: 1.

limitstring

Items per page (max 200). Default: 50.

Request

GET /bff/routing/list

get

curl -X GET "https://api.bizkithub.com/bff/routing/list?typeCode=article&relatedEntityId=42&slug=my-article&canonical=true&locale=cs&page=1&limit=50" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Paginated list of routes.

{
  "items": [
    {
      "id": "example_id",
      "typeCode": "example_typeCode",
      "slug": "example_slug",
      "canonical": false,
      "relatedEntityId": 0,
      "locale": "example_locale"
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key