List categories

Returns a flat list of all categories for your site. Use `GET /categories/tree` for the nested hierarchy.

Required permissions

categories.view

GET/categories

Base URLhttps://api.lynkow.com/v1

Query parameters

dateFromstring

Filter from date (ISO 8601)

dateTostring

Filter until date (ISO 8601)

excludeIdsstring[]

Array of strings

idsstring[]

Array of strings

includeChildrenboolean

Boolean

isRootboolean

Boolean

limitnumber

Number <= 100

Max: 100

pagenumber

Number

parentIdany

Parent resource ID

searchstring

Full-text search query

slugstring

URL-friendly identifier, unique per site and locale

slugsstring[]

Array of strings

sortByenum("created_at" | "updated_at" | "name" | "slug" | "display_order")

One of: created_at, updated_at, name, slug, display_order

sortOrderenum("asc" | "desc")

One of: asc, desc

View as markdown Install Lynkow Skills

curl --request GET \
  --url 'https://api.lynkow.com/v1/categories' \
  --header 'Authorization: Bearer $API_TOKEN'

{
  "data": [
    {
      "id": 1,
      "name": "Tutorials",
      "slug": "tutorials",
      "locale": "en",
      "parentId": null,
      "createdAt": "2025-01-10T09:00:00.000Z",
      "description": "Step-by-step guides and how-tos",
      "contentCount": 12
    },
    {
      "id": 2,
      "name": "API Guides",
      "slug": "api-guides",
      "locale": "en",
      "parentId": 1,
      "createdAt": "2025-01-12T14:00:00.000Z",
      "description": "REST API integration tutorials",
      "contentCount": 5
    }
  ],
  "meta": {
    "total": 8,
    "perPage": 15,
    "lastPage": 1,
    "currentPage": 1
  }
}

Feedback

Query parameters

Was this page helpful?