Skip to content
Glasswise Docs

/v1/catalog/capsule-types

GET
/v1/catalog/capsule-types
curl --request GET \
  --url 'https://example.com/v1/catalog/capsule-types?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.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
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

Responses

Section titled “ Responses ”

200

Section titled “200”

Catalogue: capsule-types

Media typeapplication/json
object
items
required
Array<object>
<= 200 items
object
id
required
string format: uuid
name
required
string | null
<= 2000 characters
weight
required
number | null
material
required
object
id
required
string format: uuid
name
required
string | null
<= 2000 characters
limit
required
integer
offset
required
integer
has_more
required
boolean
Examplegenerated
{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "weight": 1,
      "material": {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example"
      }
    }
  ],
  "limit": 1,
  "offset": 1,
  "has_more": true
}

400

Section titled “400”

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"
}

401

Section titled “401”

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"
}

502

Section titled “502”

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"
}