### Example Web Page Code Source: https://help.quickbase.com/docs/api-getrecordashtml A complete HTML example showing how to embed a Quickbase record using API_GetRecordAsHTML. ```APIDOC ## Example Web Page Code ### Description This is a full HTML page example demonstrating the embedding of a Quickbase record. ### Code Example ```html

Example

A Quickbase table embedded in a page of HTML

``` ``` -------------------------------- ### AND Query Example Source: https://help.quickbase.com/docs/api-doquery This example shows how to combine two conditions using AND to ensure both criteria are met for a record to be returned. ```xml {'7'.EX.'Ragnar Lodbrok'}AND{9.CT.'Erich'} ``` -------------------------------- ### GetRecords() Example with Field Reference Source: https://help.quickbase.com/docs/getrecords-formula-query-function This example shows how to dynamically query records by referencing the value of another field (Manager name) within the same record. It also includes an example for querying a different table using its alias. ```formula GetRecords("{6.EX.'"&[Manager name]&"'}") ``` ```formula GetRecords("{6.EX.'"&[Manager name]&"'}",[_DBID_PROJECTS]) ``` -------------------------------- ### Example Web Page with Embedded Quickbase Record Source: https://help.quickbase.com/docs/api-getrecordashtml This is a complete HTML page example that embeds a Quickbase record. It includes basic HTML structure, a placeholder div for the record, and a JavaScript snippet to fetch and display the record's HTML. ```html

Example

A Quickbase table embedded in a page of HTML

``` -------------------------------- ### Example Quickbase RSS Feed URL Source: https://help.quickbase.com/docs/subscribe-to-a-quickbase-rss-feed An example of a complete Quickbase RSS feed URL using sample account, database, query, and user token values. ```URL https://myaccount.quickbase.com/db/12345?a=rss&qid=1&user_token=abcdef1234567890 ``` -------------------------------- ### Basic Query Example Source: https://help.quickbase.com/docs/api-doquery This example demonstrates a simple query to find records where a specific field contains a given string. ```xml {'5'.CT.'Ragnar Lodbrok'} ``` -------------------------------- ### Exact Match Query (URL) Source: https://help.quickbase.com/docs/api-doquery This URL example demonstrates how to perform an exact match query for a string value. ```url http://target_domain/db/target_dbid?a=API_DoQuery&query={7.EX.'Ragnar Lodbrok'} ``` -------------------------------- ### OR and AND Query Example Source: https://help.quickbase.com/docs/api-doquery This example illustrates a more complex query combining OR and AND operators to match records based on multiple conditions. ```xml ({'6'.EX.'Six'}OR{'6'.EX.'Seven'})AND{'7'.GTE.'2'} ``` -------------------------------- ### API_DoQuery - XML Request Example Source: https://help.quickbase.com/docs/api-doquery This snippet shows an example of how to make an API_DoQuery call using an XML POST request. ```APIDOC ## API_DoQuery ### Description Performs a query against a Quickbase table to retrieve records based on specified criteria. ### Method POST ### Endpoint https://target_domain/db/target_dbid ### Request Body ```xml auth_ticket app_token mydata {'5'.CT.'Ragnar Lodbrok'}AND{'5'.CT.'Acquisitions'} 1 5.6.7.22.3 3 num-4.sortorder-A.skp-10.onlynew structured ``` ### Response #### Success Response (200) - **action** (string) - The originating request, for example, API_DoQuery. - **errcode** (string) - Identifies the error code. 0 indicates no error. - **errtext** (string) - Text that explains the error code. "No error" indicates no error. - **udata** (string) - Optional. Contains any udata value supplied in the request. - **records** (aggregate) - The records returned, structure depends on the `fmt` parameter. - If `fmt` is NOT specified: dbinfo, variables, chdbids, and record aggregates. - If `fmt` IS specified: a super-aggregate containing `original`, `variables`, `queries`, `fields`, and `records` aggregates. ### Response Example (Success) ```json { "action": "API_DoQuery", "errcode": "0", "errtext": "No error", "udata": "mydata", "records": [ { "rid": "1", "field": { "5": "Example Record Data" } } ] } ``` ``` -------------------------------- ### Field Value Comparison Query (XML) Source: https://help.quickbase.com/docs/api-doquery This XML example shows how to query records by comparing the value of one field against the value of another field. ```xml {7.XEX.'_FID_10'} ``` -------------------------------- ### Field Value Comparison Query (URL) Source: https://help.quickbase.com/docs/api-doquery This URL example demonstrates querying records by comparing the value in one field to the value in another field. ```url http://target_domain/db/target_dbid?a=API_DoQuery&query={7.XEX.'_FID_10'} ``` -------------------------------- ### API_DoQuery - URL Alternative Example Source: https://help.quickbase.com/docs/api-doquery This snippet shows an alternative way to make an API_DoQuery call using URL parameters. ```APIDOC ## API_DoQuery - URL Alternative ### Description An alternative method to call API_DoQuery using URL parameters instead of a POST body. ### Method GET ### Endpoint https://target_domain/db/target_dbid?a=API_DoQuery&includeRids=1&ticket=auth_ticket&apptoken=app_token&udata=mydata&query={'5'.CT.'Ragnar Lodbrok'}AND{'5'.CT.'Acquisitions'}&clist=5.6.7.22.3&slist=3&options=num-4.nosort.skp-10.onlynew&fmt=structured ### Parameters #### Query Parameters - **a** (string) - Required - Specifies the action to perform, e.g., API_DoQuery. - **includeRids** (string) - Optional - Include record IDs in the response. - **ticket** (string) - Required - Authentication ticket. - **apptoken** (string) - Required - Application token for authentication. - **udata** (string) - Optional - User data to be included in the response. - **query** (string) - Required - The query criteria for filtering records. - **clist** (string) - Optional - Comma-separated list of field IDs to include in the response. - **slist** (string) - Optional - Comma-separated list of field IDs to sort by. - **options** (string) - Optional - Query options, such as sorting and pagination. - **fmt** (string) - Optional - Specifies the response format (e.g., 'structured'). ### Response (See Response section in the XML Request Example for details on success and error responses.) ``` -------------------------------- ### GetRecords() Example with Hard-coded Value Source: https://help.quickbase.com/docs/getrecords-formula-query-function This example demonstrates querying records where a specific field (ID 6) matches a hard-coded string value ('In Progress'). It also shows how to query a different table using its alias. ```formula GetRecords("{6.EX.'In Progress'}") ``` ```formula GetRecords("{6.EX.'In Progress'}", [_DBID_PROJECTS]) ``` -------------------------------- ### Sample XML Response for API_GetDBInfo Source: https://help.quickbase.com/docs/api-getdbinfo This is an example of a successful XML response from the API_GetDBInfo call, detailing various metadata attributes of the table. ```xml API_GetDBInfo 0 No error test 1205806751959 1205877093679 1204745351407 3 112149.bhsv AppBoss 2.0 (UTC-08:00) Pacific Time (US & Canada) ``` -------------------------------- ### GetFieldValues() Example - Hardcoded Value (Same Table) Source: https://help.quickbase.com/docs/getfieldvalues-formula-query-function Example demonstrating how to get field values from records where a specific field has a hardcoded value. Returns record IDs. ```formula GetFieldValues(GetRecords("{6.EX.'In Progress'}"), 3) ``` -------------------------------- ### Create a solution Source: https://help.quickbase.com/docs/solution-apis Apply a yaml file with a valid QBL definition to create a new solution and the apps it contains. The user making the create call will become solution owner and app manager of the newly created resources. ```APIDOC ## Create a solution ### Description Apply a yaml file with a valid QBL definition to create a new solution and the apps it contains. The user making the create call will become solution owner and app manager of the newly created resources. ### Capability Create a solution ``` -------------------------------- ### GetFieldValues() Example - Field Reference (Same Table) Source: https://help.quickbase.com/docs/getfieldvalues-formula-query-function Example demonstrating how to get field values based on a reference to another field within the same table. Retrieves values from field ID 10. ```formula GetFieldValues(GetRecords("{6.EX.'"&[Manager name]&"'}"), 10) ``` -------------------------------- ### Create solution from record Source: https://help.quickbase.com/docs/solution-apis Apply a yaml file with a valid QBL definition from a record to create a new solution and the apps it contains. The user making the create call will become solution owner and app manager of the newly created resources. ```APIDOC ## Create solution from record ### Description Apply a yaml file with a valid QBL definition from a record to create a new solution and the apps it contains. The user making the create call will become solution owner and app manager of the newly created resources. ### Capability Create solution from record ``` -------------------------------- ### GetFieldValues() Example - Hardcoded Value (Different Table) Source: https://help.quickbase.com/docs/getfieldvalues-formula-query-function Example demonstrating how to get field values from records in a different table (specified by alias) where a field has a hardcoded value. Returns record IDs. ```formula GetFieldValues(GetRecords("{6.EX.'In Progress'}", [_DBID_PROJECTS]), 3) ``` -------------------------------- ### Sample XML Request for API_GetRecordInfo Source: https://help.quickbase.com/docs/api-getrecordinfo This snippet shows how to construct an XML request to the API_GetRecordInfo endpoint. Ensure you replace target_domain and target_dbid with your specific Quickbase domain and database ID. ```xml POST https://target_domain/db/target_dbid HTTP/1.0 Content-Type: application/xml Content-Length: QUICKBASE-ACTION: API_GetRecordInfo mydata auth_ticket app_token 2 ``` -------------------------------- ### GetFieldValues() Example - Field Reference (Different Table) Source: https://help.quickbase.com/docs/getfieldvalues-formula-query-function Example demonstrating how to get field values from a different table (specified by alias) based on a reference to another field. Retrieves values from field ID 10. ```formula GetFieldValues(GetRecords("{6.EX.'"&[Manager name]&"'}", [_DBID_PROJECTS]), 10) ``` -------------------------------- ### Find() formula function example Source: https://help.quickbase.com/docs/quickbase-april-2021-release-notes The `find()` formula function returns the starting index of a defined string within another string. This can be used in conjunction with other text functions. For example, `Find("hello", "ello")` returns `2`. ```Formula find("hello", "ello") ``` -------------------------------- ### Example Quickbase Formula Structure Source: https://help.quickbase.com/docs/formulas-4 Illustrates the basic structure of a Quickbase formula, including a function, arguments, and conditional logic. Use this as a template for simple conditional calculations. ```Quickbase Formula If([Order Complete]=TRUE, [SUBTOTAL] + [TAX], null) ``` -------------------------------- ### API_GetFieldProperties - HTTP GET Request Source: https://help.quickbase.com/docs/api-getfieldproperties This snippet demonstrates how to call API_GetFieldProperties using an HTTP GET request. ```APIDOC ## API_GetFieldProperties - HTTP GET Request ### Description Retrieve field properties by making an HTTP GET request to the specified endpoint. ### Method GET ### Endpoint https://target_domain/db/target_dbid?a=API_GetFieldProperties&fid={fid} ### Parameters #### Query Parameters - **a** (string) - Required - The action to perform, which is 'API_GetFieldProperties'. - **fid** (integer) - Required - The ID of the field whose properties you want to retrieve. ### Response #### Success Response (200) - **action** (string) - The originating request, for example, API_GetFieldProperties. - **errcode** (integer) - Identifies the error code. 0 indicates no error. - **errtext** (string) - Text that explains the error code. "No error" indicates no error. - **field** (object) - Contains the properties of the requested field. - **id** (string) - The ID of the field. - **field_type** (string) - The type of the field (e.g., 'url'). - **base_type** (string) - The base data type of the field (e.g., 'text'). - **mode** (string) - The mode of the field (e.g., 'virtual'). - **label** (string) - The user-facing label of the field. - **formula** (string) - The formula associated with the field, if any. ### Response Example ```xml API_GetFieldProperties 0 No error Add URL Action 0 0 0 1 0 0 1 URLRoot () &"db/" & [_DBID_URL_ACTIONS] & "?a=API_GenAddRecordForm&_fid_7=" & URLEncode ([Record ID#])& "&z=" & Rurl()
1 0 0 0 Add URL action 0 0 0 ``` ``` -------------------------------- ### Example Quickbase Pipelines YAML Export Source: https://help.quickbase.com/docs/using-yaml-to-write-configuration-files This is a typical export of a Quickbase pipeline in YAML format. It includes sections for META, TRIGGER, and ACTION steps, along with account slugs and input configurations. ```yaml # Bucket App # # Account slugs: # - quickbase[userxyz]: My Quickbase app # - gmail[user id]: Lois Lane # - google-calendar[userxyz]: Lois Lane --- - META: name: Bucket App - TRIGGER quickbase[userxyz] record on_create -> a: inputs-meta: export_fields: 8, 11, 14, 13, 12, 9, 10, 34, 46, 38, 33, 23, 32, 24, 41, 28, 6, 37, 15, 18, 21, 20, 19, 16, 17, 49, 22, 7, 48, 31, 36, 44, 43, 26, 35, 42, 39, 40, 25, 47, 27, 45 table: bqexx2ivj - ACTION bucket row create -> b: inputs-meta: table: '5876036948459520' - ACTION gmail[userxyz] message send -> c: inputs: to: '{{a.record_owner.email}}' - ACTION google-calendar[userxyz] event create -> d: inputs-meta: calendar: en.bulgarian#holiday@group.v.calendar.google.com inputs: end_at: 2021-03-03T17:00:00+0200 start_at: 2021-03-03T16:00:00+0200 summary: '{{a.first_name}} {{a.last_name}}' ... ``` -------------------------------- ### API_GetGroupRole - HTTP GET Request Source: https://help.quickbase.com/docs/api-getgrouprole This snippet demonstrates how to make an API_GetGroupRole call using an HTTP GET request. ```APIDOC ## API_GetGroupRole - HTTP GET Request ### Description Use API_GetGroupRole to determine the roleid for a group within an application. ### Method GET ### Endpoint https://target_domain/db/target_dbid ### Parameters #### Query Parameters - **a** (string) - Required - The action to perform, which is 'API_GetGroupRole'. - **gid** (string) - Required - The id of the group to manage. - **apptoken** (string) - Required - A valid application token (if the application requires application tokens). - **ticket** (string) - Required - A valid authentication ticket (returned via API_Authenticate). - **usertoken** (string) - Required - The user token for API access. - **udata** (string) - Optional - A string value that you want returned. ### Request Example ``` https://target_domain/db/target_dbid?a=API_GetGroupRole&gid=345889.klsd&ticket=auth_ticket&udata=misc%20data ``` ### Response Values #### Success Response (200) - **action** (string) - The originating request, for example, API_GetGroupRole. - **errcode** (integer) - Identifies the error code. 0 indicates no error. - **errtext** (string) - Text that explains the error code. "No error" indicates no error. - **udata** (string) - Optional. Contains any udata value supplied in the request. - **roles** (object) - The roles the group has in the app. - **role** (object) - Represents a single role. - **id** (string) - The ID of the role. - **name** (string) - The name of the role. #### Response Example ```xml API_GetGroupRole 0 No error misc data Participant ``` ``` -------------------------------- ### Edit Record and Display in Quickbase Source: https://help.quickbase.com/docs/api-editrecord This example illustrates how to edit a record and then display it within the Quickbase application by setting the 'disprec' parameter to 1. An application login is required for display. ```xml 1 3 Hi! 1 your_ticket ``` -------------------------------- ### Using Aggregate Functions on Formula Queries Source: https://help.quickbase.com/docs/quickbase-april-2025-release-notes Demonstrates the usage of aggregate functions like Min, Max, and Median on the results of a formula query. Ensure the query syntax is correct for your specific needs. ```quickbase Min(GetRecords(“{3.GT.0}“), 22) ``` ```quickbase Max(GetRecords(“{3.GT.0}“), 22) ``` ```quickbase Median(GetRecords(“{3.GT.0}“), 22) ``` -------------------------------- ### URL Alternative for API_GetUserInfo Source: https://help.quickbase.com/docs/api-getuserinfo This demonstrates an alternative way to call API_GetUserInfo using URL parameters. Replace _target_domain_ with your Quickbase domain. ```plaintext https://target_domain/db/main?a=API_GetUserInfo&ticket=auth_ticket &email=Ragnar-Lodbrok@paris.net ``` -------------------------------- ### HTTP GET Request for API_GrantedGroups Source: https://help.quickbase.com/docs/api-grantedgroups This is a sample HTTP GET request for the API_GrantedGroups endpoint. Replace placeholders with your actual ticket and user ID. ```plaintext https://target_domain/db/main?a=API_GrantedGroups&userid=930245.jlpw& ticket=auth_ticket&udata=misc%20data ``` -------------------------------- ### Export solution to record Source: https://help.quickbase.com/docs/solution-apis Provides the QBL definition for the supported schema of all apps in the Solution in the format of a yaml file, then uploads the file to a record in a specified Quickbase table. Solution owners or contributors can make an export call. ```APIDOC ## Export solution to record ### Description Provides the QBL definition for the supported schema of all apps in the Solution in the format of a yaml file, then uploads the file to a record in a specified Quickbase table. Solution owners or contributors can make an export call. ### Capability Export solution to record ``` -------------------------------- ### Get Ancestor Info - XML Request Source: https://help.quickbase.com/docs/api-getancestorinfo Use this XML request to get ancestor information for an application. Ensure you have a valid authentication ticket and app token. ```xml POST https://target_domain/db/target_dbid Content-Type: application/xml Content-Length: QUICKBASE-ACTION:API_GetAncestorInfo auth_ticket app_token ``` -------------------------------- ### Sample HTTP GET Request for API_GetFieldProperties Source: https://help.quickbase.com/docs/api-getfieldproperties This is an alternative method to retrieve field properties using an HTTP GET request. The field ID is passed as a query parameter. ```plaintext https://target_domain/db/target_dbid?a=API_GetFieldProperties&fid=35 ``` -------------------------------- ### HTTP GET Request for API_GetGroupRole Source: https://help.quickbase.com/docs/api-getgrouprole This HTTP GET request can be used as an alternative to the XML POST request for the API_GetGroupRole call. It includes the group ID, authentication ticket, and optional user data. ```http https://target_domain/db/target_dbid?a=API_GetGroupRole&gid=345889.klsd& ticket=auth_ticket&udata=misc%20data ``` -------------------------------- ### Update a solution Source: https://help.quickbase.com/docs/solution-apis Apply a yaml file with a valid QBL definition to an already existing Solution to update all schema in the solution to match the one in the yaml. Learn more about how Quickbase updates schema in Logical IDs. ```APIDOC ## Update a solution ### Description Apply a yaml file with a valid QBL definition to an already existing Solution to update all schema in the solution to match the one in the yaml. Learn more about how Quickbase updates schema in Logical IDs. ### Capability Update a solution ``` -------------------------------- ### Sample HTTP GET Request for API_GetUsersInGroup Source: https://help.quickbase.com/docs/api-getusersingroup This HTTP GET request shows an alternative way to call API_GetUsersInGroup. It includes parameters for group ID, inclusion of all managers, authentication ticket, and user data. ```http https://target_domain/db/main?a=API_GetUsersInGroup&gid=2345.skdj&includeAllMgrs=true&ticket=auth_ticket&udata=misc%20data ``` -------------------------------- ### Update solution from record Source: https://help.quickbase.com/docs/solution-apis Apply a yaml with a valid QBL definition from a record to an already existing Solution to update all schema in the solution to match the one in the yaml. Learn more about how Quickbase updates schema in Logical IDs. ```APIDOC ## Update solution from record ### Description Apply a yaml with a valid QBL definition from a record to an already existing Solution to update all schema in the solution to match the one in the yaml. Learn more about how Quickbase updates schema in Logical IDs. ### Capability Update solution from record ```