Shared

What the share link shows: its name, the views it opens and its toggles

GET /api/shared/{shareToken}

Access: anyone.

Parameters

Responses

• 200 Success
  • kind "view" | "base" | "form" required
  • name string required
  • tables array of object required
    • name string required
    • views array of object required
      • id string (uuid) required
      • name string required
      • type "grid" | "gallery" | "kanban" | "calendar" | "timeline" | "list" | "form" required
  • allowCopy boolean required
  • allowDownload boolean required
  • expiresAt string (date-time) | null required
• 429 Too many requests: a rate limit was reached (see Retry-After)

Enter a share link's password; sets a cookie for this link (12 hours at most)

POST /api/shared/{shareToken}/unlock

Access: anyone.

Parameters

Request body

• password string required
• captchaToken string

Responses

• 204 Success, no content
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

A shared view: its name, visible fields and layout

GET /api/shared/{shareToken}/views/{viewId}

Access: anyone.

Parameters

Responses

• 200 Success
  • view object required
    • name string required
    • type "grid" | "gallery" | "kanban" | "calendar" | "timeline" | "list" | "form" required
  • table object required
    • name string required
  • fields array of object required
    • id string (uuid) required
    • name string required
    • type "singleLineText" | "longText" | "number" | "currency" | "percent" | "checkbox" | "date" | "dateTime" | … required
    • options any required
    • isPrimary boolean required
  • layout object required
    • fieldOrder array of string (uuid)
    • columnWidths object
    • frozenCount integer
    • rowHeight "compact" | "default" | "medium" | "tall"
  • kanban object
    • stackFieldId string (uuid) | null
    • cardFields array of string (uuid)
    • coverFieldId string (uuid) | null
    • collapseEmpty boolean
  • calendar object
    • dateFields array of object
      • startFieldId string (uuid) required
      • endFieldId string (uuid) | null
    • colorFieldId string (uuid) | null
    • mode "month" | "week" | "day"
  • gallery object
    • cardFields array of string (uuid)
    • coverFieldId string (uuid) | null
    • coverFit "crop" | "fit"
    • cardSize "small" | "medium" | "large"
  • timeline object
    • startFieldId string (uuid) | null
    • endFieldId string (uuid) | null
    • scale "day" | "week" | "month"
    • groupFieldId string (uuid) | null
    • colorFieldId string (uuid) | null
    • dependencyFieldId string (uuid) | null
  • list object
    • parentFieldId string (uuid) | null
    • rowFields array of string (uuid)
  • expiresAt string (date-time) | null required
• 429 Too many requests: a rate limit was reached (see Retry-After)

A window of a shared view's records, with its filter and order

GET /api/shared/{shareToken}/views/{viewId}/records

Access: anyone.

Parameters

Responses

• 200 Success
  • records array of object required
    • id string (uuid) required
    • fields object required
    • links object
  • offset integer required
  • total integer required
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)