Skip to content
Starlight OpenAPI

List all categories

GET
/categories

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer format: int32
nullable <= 50

How many categories to return at one time (max 100)

offset
integer format: int32

The number of categories to skip before starting to collect the result set

Responses

Section titled “Responses”

200

Section titled “200”

A paged array of categories

Media typeapplication/json
Array<object>
<= 100 items
object
id
required
integer format: int64
name
required
string
posts
Array<object>
<= 100 items
object
id
required
integer format: int64
name
required
string
text
string
category
object recursive
related
Array
One of:
object
id
required
integer format: int64
name
required
string
text
string
category
object recursive
Examplegenerated
[
  {
    "id": 1,
    "name": "example",
    "posts": [
      {
        "id": 1,
        "name": "example",
        "text": "example",
        "category": {}
      }
    ],
    "related": [
      {
        "id": 1,
        "name": "example",
        "text": "example",
        "category": {}
      }
    ]
  }
]

default

Section titled “default”

Unexpected error

Media typeapplication/json
object
code
required
integer format: int32
message
required
string
causes
Array<object> recursive| null
Examplegenerated
{
  "code": 1,
  "message": "example",
  "causes": []
}