API_GetUsersInGroup

Overview

Use API_GetUsersInGroup to get the list of users and groups that make up the members and/or managers of a group.

Request parameters

Parameter

Value

Required?

gid

The id of the group to list.

yes

ticket

A valid authentication ticket.

The authentication ticket is returned via the API_Authenticate call.

yes

includeAllMgrs

True or false (default).

When this is set to true, both members and managers of the group are returned.

no

udata

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

no

top

Response values

Element Name

Value

action

The originating request, for example, API_GetUsersInGroup.

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.

users

A list of the users in the group.

groups

A list of the subgroups  in the group.

top

Sample XML Request

POST https://target_domain/db/main HTTP/1.1
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION:API_GetUsersInGroup

<qdbapi>
   <udata>misc data</udata>
   <ticket>auth_ticket</ticket>
   <includeAllMgrs>true</includeAllMgrs>
   <gid>2345.skdj</gid>
</qdbapi>

top

Sample HTTP Get Request

https://target_domain/db/main?a=API_GetUsersInGroup&gid=2345.skdj&includeAllMgrs=true&ticket=auth_ticket&udata=misc%20data

where target_domain is the domain against which you are invoking this call, for example, intuit.quickbase.com. Read about this notation.

top

Sample response

<?xml version="1.0" ?>
<qdbapi>
   <action>API_GetUsersInGroup</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <udata>misc data</udata>
   <group id=”2345.sdfk”>
    <name>GroupInfoTestGroup</name>
    <description>My Group description</description>
    <users>
    <user id="112149.bhsv">
       <firstName>john</firstName>
       <lastName>doe</lastName>
       <email>jdoe.qb@gmail.com</email>
       <screenName></screenName>
       <isAdmin>false</isAdmin>
    </user>
    <user id="192156.mqbr">
       <firstName>justin</firstName>
       <lastName>sample</lastName>
       <email>justin@example.com</email>
       <screenName></screenName>
       <isAdmin>false</isAdmin>
    </user>
    </users>
    <managers>
    <manager id="52731770.b82h">
       <firstName>Angela</firstName>
       <lastName>Leon</lastName>
       <email>angela_leon@aleon.com</email>
       <screenName>aqleon</screenName>
       <isMember>true</isMember>
    </manager>
    </managers>
    <subgroups>
    <subgroup id=”3450.aefs”/>
    </subgroups>
   </group>
</qdbapi>

 

Go back    |     |  

© 1999-2017 QuickBase, Inc. All rights reserved. Legal Notices.