Get a collection | Runtype Documentation

{
  "createdAt": "2024-05-10T09:15:00Z",
  "description": "A collection of user profiles with contact information and preferences.",
  "displayName": "User Profiles",
  "icon": "👥",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
  "indexedFields": [
    "email",
    "name"
  ],
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      },
      "email": {
        "type": "string",
        "format": "email"
      },
      "age": {
        "type": "integer"
      },
      "newsletterSubscribed": {
        "type": "boolean"
      }
    }
  },
  "schemaVersion": 3,
  "slug": "user-profiles",
  "updatedAt": "2024-05-09T16:45:00Z",
  "validationMode": "enforce",
  "history": [
    {
      "changeKind": "additive",
      "changedBy": "jane.doe@runtype.com",
      "createdAt": "2024-04-01T12:00:00Z",
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "age": {
            "type": "integer"
          },
          "newsletterSubscribed": {
            "type": "boolean"
          }
        }
      },
      "version": 1
    }
  ],
  "recordCount": 2543
}

Get a collection by slug. includeHistory=true embeds the append-only schema version history.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

slugstringRequired

Query parameters

includeHistorystringOptional

Response

Collection

createdAtstring

descriptionstring or null

displayNamestring

iconstring or null

idstring

indexedFieldslist of strings

schemamap from strings to any or null

Constrained JSON Schema dialect: root object with string/number/boolean/array/object properties, one nesting level, no $ref/oneOf/pattern

schemaVersioninteger

slugstring

updatedAtstring

validationModeenum

historylist of objects

recordCountinteger

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/collections/slug \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"