Scripts

A base's saved scripts by name (editors and up)

GET /api/bases/{baseId}/scripts

Access: base:read_scripts on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 200 Success
  • scripts array of object required
    • id string (uuid) required
    • baseId string (uuid) required
    • name string required
    • description string required
    • code string required
    • createdBy string (uuid) | null required
    • updatedBy string (uuid) | null required
    • createdAt string (date-time) required
    • updatedAt string (date-time) required
  • canEdit boolean required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)

Save a new script (creators and up)

POST /api/bases/{baseId}/scripts

Access: base:manage_scripts on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Request body

• name string required
• description string
• code string

Responses

• 201 Success
  • id string (uuid) required
  • baseId string (uuid) required
  • name string required
  • description string required
  • code string required
  • createdBy string (uuid) | null required
  • updatedBy string (uuid) | null 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)

A saved script (editors and up)

GET /api/bases/{baseId}/scripts/{scriptId}

Access: base:read_scripts on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 200 Success
  • id string (uuid) required
  • baseId string (uuid) required
  • name string required
  • description string required
  • code string required
  • createdBy string (uuid) | null required
  • updatedBy string (uuid) | null 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
• 429 Too many requests: a rate limit was reached (see Retry-After)

Rename a script or change its code (creators and up)

PATCH /api/bases/{baseId}/scripts/{scriptId}

Access: base:manage_scripts on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Request body

• name string
• description string
• code string

Responses

• 200 Success
  • id string (uuid) required
  • baseId string (uuid) required
  • name string required
  • description string required
  • code string required
  • createdBy string (uuid) | null required
  • updatedBy string (uuid) | null 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)

Delete a script (creators and up)

DELETE /api/bases/{baseId}/scripts/{scriptId}

Access: base:manage_scripts on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 204 Success, no content
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)