Class BaserowClient

constructor

• new BaserowClient(config: BaserowClientConfig): BaserowClient

  Parameters

  • config: BaserowClientConfig

  Returns BaserowClient

Readonlyadmin

Readonlyapplications

Readonlybuilder

Readonlydashboard

ReadonlydatabaseFields

ReadonlydatabaseRows

ReadonlydatabaseTables

ReadonlydatabaseTokens

ReadonlydatabaseViews

ReadonlydatabaseWebhooks

Readonlyhealth

Readonlyintegrations

Readonlyjobs

Readonlylicenses

Readonlynotifications

ReadonlyroleAssignments

ReadonlysecureFiles

Readonlysso

Readonlyteams

Readonlytemplates

Readonlytrash

Readonlyuser

ReadonlyuserFiles

ReadonlyuserSources

Readonlyworkspace

_request

• _request<T = any>(
      method: "GET" | "POST" | "PATCH" | "DELETE" | "PUT",
      path: string,
      queryParams?: Record<
          string,
          undefined
          | null
          | string
          | number
          | boolean
          | string[],
      >,
      body?: any,
      additionalHeaders?: Record<string, string>,
  ): Promise<T>

  Internal method to make authenticated requests to the Baserow API.

  Type Parameters

  • T = any

  Parameters

  • method: "GET" | "POST" | "PATCH" | "DELETE" | "PUT"

    HTTP method (GET, POST, PATCH, DELETE, PUT).
  • path: string

    API endpoint path (e.g., /api/database/rows/table/1/).
  • OptionalqueryParams: Record<string, undefined | null | string | number | boolean | string[]>

    Optional object for URL query parameters.
  • Optionalbody: any

    Optional request body for POST/PATCH/PUT requests.
  • OptionaladditionalHeaders: Record<string, string>

    Optional additional headers.

  Returns Promise<T>

  The parsed JSON response or raw response for non-JSON types.

  Throws

  If the API returns an error status.