Skip to main content
GET
List labels

Authorizations

Authorization
string
header
required

API token authentication

Query Parameters

page
integer
default:1

The collection page number

title
string

Label title

title[]
string[]

Label title

country
string

Label country

country[]
string[]

Label country

label_code
string

Label label_code

label_code[]
string[]

Label label_code

q
string

Label q

exists[country]
boolean

Filter on whether a country is set. true returns labels that have one, false those left unspecified. Combines with country as AND, so country=DE&exists[country]=false is contradictory and returns nothing. Has no effect alongside the free-text q parameter, which is answered by the search index and applies no field filters.

order[country]
enum<string>

Sort by country. Labels without a country are always listed last, in both directions.

Available options:
asc,
desc,
ASC,
DESC
order[title]
enum<string>

Label order[title]

Available options:
asc,
desc,
ASC,
DESC

Response

Label collection

Label.jsonapi collection.

data
object[]
required
Example:
meta
object