Skip to main content
GET
List classifications

Authorizations

X-Qanapi-Authorization
string
header
required

A machine credential, qk_ followed by its secret. Only a hash of the secret is stored, so a key is displayed exactly once, when it is created or rotated. A key reaches only the configurations it is linked to.

It may also be sent as Authorization: Bearer qk_..., which is recognised by the prefix.

Query Parameters

page
integer
default:1

1-based page number. A missing, zero or unparseable value is the first page.

Required range: x >= 1
per_page
integer
default:15

Rows per page. A larger figure is reduced to the maximum rather than refused.

Required range: 1 <= x <= 200

Response

A page of classifications.

The pagination envelope. path and every *_page_url are absolute, so a client can follow next_page_url directly.

current_page
integer
required
data
object[]
required
last_page
integer
required

At least 1

path
string<uri>
required
per_page
integer
required
total
integer
required

Every matching record, not the number on this page.

first_page_url
string<uri>
from
integer | null

1-based index of the first row on this page; null when empty.

last_page_url
string<uri>

Built for rendering a pager. Labels carry HTML entities.

next_page_url
string<uri> | null
prev_page_url
string<uri> | null
to
integer | null

1-based index of the last row on this page; null when empty.