Quickbase

https://help.quickbase.com/docs
Admin
Quickbase is a low-code application development platform that enables users to build, manage, and...
Tokens:1,109,614
Snippets:9,282
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Web Page Embedding a Record

Source: https://help.quickbase.com/docs/api-getrecordashtml

A complete HTML page example demonstrating how to embed a Quickbase record.

```html
<html>
<head>
<!-- put styling information here -->
</head>
<body>
<h1>Example</h1>
<p> A Quickbase table embedded in a page of HTML</p>
<div id="dbPagePayload"></div>
<script lang="text/javascript">
$.post("./target_dbid?a=API_GetRecordAsHTML&rid=20", {}, function(response){
$("#dbPagePayload").html(response);
});
</script>
</body>
</head>
</html>
```

--------------------------------

### API_RemoveSubgroup HTTP GET Request

Source: https://help.quickbase.com/docs/api-removesubgroup

An example of an HTTP GET request to remove a subgroup.

```http
https://target_domain/db/main?a=API_RemoveSubgroup&gid=345889.jksd
&subgroupid=345889.skld&ticket=auth_ticket&udata=misc%20data
```

--------------------------------

### API_GrantedGroups HTTP GET Request

Source: https://help.quickbase.com/docs/api-grantedgroups

An example of an HTTP GET request for the API_GrantedGroups method.

```text
https://target_domain/db/main?a=API_GrantedGroups&userid=930245.jlpw&
ticket=auth_ticket&udata=misc%20data
```

--------------------------------

### Quickbase API URL with Application Token

Source: https://help.quickbase.com/docs/app-tokens

Example of a complete API URL for cloning a database, including the required apptoken parameter.

```text
https://myaccount.quickbase.com/db/bdz6zm7uy?a=api_clonedatabase&newdbname=MyTestApp&newdbdesc=Testing&keepData=1&apptoken=bghbnjfu7s9amn7akduwomaytzy
```

--------------------------------

### Header 1 Configuration

Source: https://help.quickbase.com/docs/webhooks-channel

Example of a specific header key.

```text
HEADER_1
```

--------------------------------

### API_GetGroupRole HTTP GET Request

Source: https://help.quickbase.com/docs/api-getgrouprole

An example of an HTTP GET request to the API_GetGroupRole endpoint.

```text
https://target_domain/db/target_dbid?a=API_GetGroupRole&gid=345889.klsd&
ticket=auth_ticket&udata=misc%20data
```

--------------------------------

### Complete parameter definition and usage example

Source: https://help.quickbase.com/docs/parameters-in-qbl

A comprehensive example demonstrating the definition of a parameter, its usage in a resource, and providing a value for it.

```yaml
Version: 0.12
ParameterDefinitions:
  QuickbaseConnectionId:
    Type: String
    Description: Parameter for $DataSource_Variables_connection
    Value: MyQuickbaseConnectionId # if the param isn't passed, use the default value
Resources: 
  $App: 
    Type: QB::Application
    Properties:
ExternalResources:
  $DataSource_Variables_connection:
    Type: QB::ConnectedDataSource::Quickbase
    Id: !Var 
      Name: QuickbaseConnectionId
Parameters: 
  QuickbaseConnectionId: 17823137812
```

--------------------------------

### API_GetFieldProperties HTTP GET Request

Source: https://help.quickbase.com/docs/api-getfieldproperties

An example of an HTTP GET request to retrieve field properties.

```http
https://target_domain/db/target_dbid?a=API_GetFieldProperties&fid=35
```

--------------------------------

### Value 2 Configuration

Source: https://help.quickbase.com/docs/webhooks-channel

Example of a specific header value.

```text
value 2
```

--------------------------------

### API_CreateGroup GET Request

Source: https://help.quickbase.com/docs/api-creategroup

An example of a GET request to create a group using URL parameters.

```text
https://target_domain/db/main?a=API_CreateGroup&accountID=212968
&name=MarketingSupport&description=Support%20staff%20for%20sr%20marketing%20group
```

--------------------------------

### API_ChangeGroupInfo HTTP GET Request

Source: https://help.quickbase.com/docs/api-changegroupinfo

An example of an HTTP GET request to modify group information.

```text
https://target_domain/db/main?a=API_ChangeGroupInfo&gid=345889.sdjl 
&name=AcmeSalesTeamLeads&Team%20Leaders%20for%20the%20Acme%20division&
ticket=auth_ticket&udata=misc%20data
```

--------------------------------

### Header 2 Configuration

Source: https://help.quickbase.com/docs/webhooks-channel

Example of a specific header key.

```text
HEADER_2
```

--------------------------------

### Define a basic Application resource in QBL

Source: https://help.quickbase.com/docs/qbl-definition-structure-and-syntax

Example of defining a basic Quickbase application resource with properties like name, description, manager, and currency symbol.

```yaml
Resources:
  $App_Project_Management_App:
    Type: QB::Application
    Properties:
      Name: Project Management App Copy
      Description: Start your project management journey with this easy to use starter app!
      Manager: rstoycheva@quickbase.com
      CurrencySymbol: $
```

--------------------------------

### Sample HTTP Get Request for API_AddSubGroup

Source: https://help.quickbase.com/docs/api-addsubgroup

An example of an HTTP GET request to perform the API_AddSubGroup action.

```text
https://target_domain/db/main?a=API_AddSubGroup&gid=345889.sdfs&subgroupid=820935.ksjf&ticket=auth_ticket&udata=misc%20data
```
Tokens:
Raw