Fetch a collection

GET

/api/v1/collections/{id}

curl --request GET \
  --url http://localhost:3000/api/v1/collections/example \
  --header 'Authorization: Bearer <token>'

Scope: read.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

id

required

string

Collection id

Responses

200

The collection

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

icon

required

string | null

fields

required

object

key

additional properties

string | number | boolean

private

required

boolean

count

required

integer

>= -9007199254740991 <= 9007199254740991

createdAt

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

Example^generated

{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "icon": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "private": true,
    "count": 1,
    "createdAt": "2026-04-15T12:00:00Z"
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}