Skip to main content
GET
List library-anomaly categories

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "subcategories": The active subcategories belonging to each category.
  • "count-library-anomalies": Adds countLibraryAnomalies (distinct active LibraryAnomaly rows referencing each category, directly or via one of its subcategories).
Available options:
subcategories,
count-library-anomalies
orderBy
object[]
whereName
string

Case-insensitive partial match on the name.

Maximum string length: 200
Example:

"lobby"

whereCreatedAt
object

Filter by creation date range.

Example:
whereUpdatedAt
object

Filter by last-update date range.

Example:
whereIncludeDeleted

When true, also returns soft-deleted categories.

Example:

true

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required