BizKitHub
DocsAPI ReferenceRouting/bff/routing/list
getRoutingAdmin BFF

/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

Query parameters

· 7
typeCodestringOptional

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

Examplearticle
relatedEntityIdstringOptional

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.

Example42
slugstringOptional

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

Examplemy-article
canonicalstringOptional

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

Exampletrue
localestringOptional

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

Examplecs
pagestringOptional

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

Example1
limitstringOptional

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

Example50

Response schema

1 status code documented

200SuccessPaginated list of routes.
itemsobject[]Required

Array of route entries matching the filter criteria.

Each array item:

Single route entry.

idstringRequired

Unique route identifier.

typeCodestringRequired

Entity type code (e.g. "article", "product-detail").

slugstringRequired

URL slug for this route.

canonicalbooleanRequired

Whether this is the canonical route for the entity.

relatedEntityIdnumberRequired

ID of the related entity (post, product, etc.).

localestringRequired

Locale code (e.g. "cs", "en").

insertedDateDate | string | string | numberRequired

Date when the route was created.

One of 4:
Variant 1
Date

Date when the route was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Total number of matching routes (before pagination).

Response example

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

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key