Quickbase¶

Overview¶

Quickbase is a workflow automation and data warehousing tool. This class allows you to interact with select functions of the the Quickbase API .

This Parsons connector provides methods to fetch lists of available tables in Quickbase, and to query those tables using Quickbase API Components Query.

Authentication

A user token and app ID are required to instantiate the Quickbase class. For details, see the Quickbase API User Tokens Documentation.

Quickstart¶

To instantiate the Quickbase class, you can either store your credentials as environment variables (QUICKBASE_HOSTNAME and QUICKBASE_USER_TOKEN) or pass them in as arguments.

Use API credentials via environmental variables¶

from parsons import Quickbase
qb = Quickbase()

Pass API credentials as arguments¶

from parsons import Quickbase
qb = Quickbase(hostname='my_hostname', user_token='my_token')

Get all tables available from a Quickbase app¶

qb.get_app_tables(app_id='my_app_id')

Get all data from a given table¶

qb.query_records(table_from='my_table_id')

API¶

class parsons.quickbase.quickbase.Quickbase(hostname=None, user_token=None)[source]¶

Instantiate the Quickbase class

Parameters:

hostname – str The URL for the homepage/login page of the organization’s Quickbase instance (e.g. demo.quickbase.com).
user_token – str The Quickbase account user token (API key). Not required if QUICKBASE_USER_TOKEN env variable is set.

Returns:

Quickbase Class

get_app_tables(app_id=None)[source]¶

Query records in a Quickbase table. This follows the patterns laid out in Quickbase query documentaiton, located here: https://help.quickbase.com/api-guide/componentsquery.html

Parameters:: app_id – str Identifies which Quickbase app from which to fetch tables.
Returns:: Table Class

query_records(table_from=None)[source]¶

Query records in a Quickbase table. This follows the patterns laid out in Quickbase query documentaiton, located here: https://help.quickbase.com/api-guide/componentsquery.html

Parameters:: from – str The ID of a Quickbase resource (i.e. a table) to query.
Returns:: Table Class