Templates

The built-in templates of the gallery, without their records

GET /api/templates

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

• 200 Success
  • templates array of object required
    • slug string required
    • name string required
    • description string required
    • category string required
    • icon string | null required
    • color string | null required
    • tables array of object required
      • name string required
      • fields number required
      • records number required
    • automations number required
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)

A built-in template in the template format: its tables, fields, views and records

GET /api/templates/{slug}

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Parameters

Responses

• 200 Success
  • format "openrows.template" required
  • version 1 required
  • slug string required
  • name string required
  • description string required
  • category string required
  • icon string | null required
  • color string | null required
  • tables array of object required
    • id string (uuid) required
    • name string required
    • description string | null required
    • fields array of object required
      • id string (uuid) required
      • name string required
      • description string | null required
      • type "singleLineText" | "longText" | "number" | "currency" | "percent" | "checkbox" | "date" | "dateTime" | … required
      • primary boolean required
      • options object required
    • views array of object required
      • id string (uuid) required
      • name string required
      • type "grid" | "gallery" | "kanban" | "calendar" | "timeline" | "list" | "form" required
      • config object required
    • records array of object required
      • id string (uuid) required
      • cells object required
  • automations array of object required
    • name string required
    • description string required
    • trigger object required
    • actions array of object required
  • interfaces array of object required
    • name string required
    • pages array of object required
      • name string required
      • config object required
        • layout "recordList" | "recordReview" | "dashboard" | "form" | "kanban" | "calendar" | "timeline" required
        • tableId string (uuid) required
        • filter object
        • sorts array of object required
        • fields array of string (uuid) required
        • elements array of object required
        • kanban object
        • calendar object
        • timeline object
        • form object
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)

Create a base from a built-in template (owners and creators)

POST /api/workspaces/{workspaceId}/templates

Access: base:create on the workspace (see ACTIONS for the minimum role); personal access tokens need schema.bases:write.

Parameters

Request body

• slug string required
• name string

Responses

• 201 Success
  • id string (uuid) required
  • workspaceId string (uuid) required
  • name string required
  • description string | null required
  • icon string | null required
  • color string | null required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
  • createdAt string (date-time) required
  • updatedAt string (date-time) required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)