Skip to content

API reference

Every public class, function, and type, with a tested example for both clients. Each page also has a plain Markdown copy for AI tools. Everything here is public, as Stability and versioning describes, and modules starting with _ are private. The async classes have the same methods as the sync ones, which you await, so they're described together.

  • Core

    The client, and the apps, tables, and reports you reach through it.

    • Quickbase Create and close a client, and call any endpoint
    • App An app's details, its tables, and schema changes with a plan
    • Table Read and write records and files, and change a table's fields
    • Report Run reports built in the Quickbase interface

  • Data

    The conditions you send, and what comes back.

    • Queries Build conditions with F, or from plain data
    • Records and results What reads and writes return, files, previews, and summaries
    • Metadata What describes apps, tables, fields, relationships, and reports
    • Field types What to write to each field type, and what it reads as

  • Schema

    Changes to tables, fields, and relationships, checked before they're made.

  • Policies

    What a client may read and change.

    • Policies Write a policy, bind it, and ask what it allows
    • Rules Allow, deny, and limit tables, fields, and rows

  • AI agents

    Operations and results for a model's tool calls.

  • Errors and retries

    What the SDK raises, and how a client retries.

    • Errors Everything the SDK raises, and what each one holds
    • Retries How a client retries rate limits and failed connections

Every public name