API_GrantedDBsForGroup

Prev Next

Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.

Overview

Use API_GrantedDBsForGroup to get a list of all the applications that a group can access.

Request parameters

Parameter

Value

Required?

gid

The id of the group to manage.

yes

ticket

A valid authentication ticket.

The authentication ticket is returned via the API_Authenticate call.

yes, one of:

ticketusername/passworduser token

usertoken

The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quickbase UI.

yes, one of:

ticketusername/passworduser token

udata

A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response.

no

Response values

Element Name

Value

action

The originating request, for example, API_GrantedDBsForGroup.

errcode

Identifies the error code, if any. (See the Error Codes appendix for a list of possible error codes.)

0 indicates that no error was encountered.

errtext

Text that explains the error code.

"No error" indicates that no error was encountered.

udata

Optional. Contains any udata value supplied in the request.

databases

A list of information about the databases where this group has access.

Sample XML Request

POST https://target_domain/db/main HTTP/1.1
Content-Type: application/xml

Content-Length:
QUICKBASE-ACTION:API_GrantedDBsForGroup

<qdbapi>
   <udata>misc data</udata>
   <ticket>auth_ticket</ticket>
   <gid>1217.dgpt</gid>
</qdbapi>

Sample XML Get Request

https://target_domain/db/main?a=API_GrantedDBsForGroup&gid=1217.dgpt&ticket=auth_ticket&udata=misc%20data
<qdbapi>
<action>API_GrantedDBsForGroup</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<databases>
<dbinfo>
<dbname>Projects</dbname>
<dbid>bhgnyxp3v</dbid>
</dbinfo>
<dbinfo>
<dbname>Project Manager Plus</dbname>
<dbid>bhgnyxp3u</dbid>
</dbinfo>
</databases>
</qdbapi>