Skip to content

/v1/catalog/sweetness

GET
/v1/catalog/sweetness
curl --request GET \
--url 'https://example.com/v1/catalog/sweetness?limit=20&offset=0' \
--header 'Authorization: Bearer <token>'

Read-only reference catalogue. Pass locale to resolve translated names; the row’s default or base name is used when no translation exists.

locale

Preferred locale for name fields. Falls back to the row’s default or base name when no translation exists.

string
>= 1 characters <= 10 characters

Preferred locale for name fields. Falls back to the row’s default or base name when no translation exists.

limit
integer
default: 20 >= 1 <= 100
offset
integer | null
0

Catalogue: sweetness

Media typeapplication/json
object
items
required
Array<object>
<= 200 items
object
value
required
string
<= 2000 characters
comment
required
string | null
<= 2000 characters
limit
required
integer
offset
required
integer
has_more
required
boolean
Examplegenerated
{
"items": [
{
"value": "example",
"comment": "example"
}
],
"limit": 1,
"offset": 1,
"has_more": true
}

Invalid query parameters

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Upstream error

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}