---
title: "API_GrantedGroups"
slug: "api-grantedgroups"
updated: 2025-08-18T09:27:12Z
published: 2025-08-18T09:27:12Z
canonical: "help.quickbase.com/api-grantedgroups"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.quickbase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API_GrantedGroups

**Don't forget to check out our** [**JSON RESTful APIs**](https://developer.quickbase.com/)**, they can help you utilize and extend Quickbase with ease.**

## Overview

Use API_GrantedGroups to get the list of groups to which a user has been granted access. If the adminOnly flag is passed, then only return groups in which this user has administration privileges.

**Note:** The user making this call must be a Realm admin.

## Request parameters

| Parameter | Value | Required? |
| --- | --- | --- |
| userid | The user id. | yes |
| adminonly | Only return groups where the user has admin rights. Default is FALSE. | no |
| ticket | A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. | yes |
| 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_GrantedGroups. |
| errcode | Identifies the error code, if any. (See the [Error Codes appendix](/v1/docs/error-codes) 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. |
| groups | A list of the user’s groups. |

## Sample XML Request

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

<qdbapi>
   <udata>misc data</udata>
   <ticket>auth_ticket</ticket>
   <userid>930245.jlpw</userid>
</qdbapi>
```

## Sample HTTP Get Request

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

```xml
<?xml version="1.0" ?>
<qdbapi>
   <action>API_GrantedGroups</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <udata>misc data</udata>
    <groups>
       <group id=”1217.dgpt”>
          <name>GroupInfoTestGroup</name>
          <description>Demo Test Group</description>
          <managedByUser>false</managedByUser>
       </group>
       <group id=”1218.sfdl”>
          <name>AnotherGroupInfoTestGroup</name>
          <description>Yet Another Demo Test Group</description>
          <managedByUser>true</managedByUser>
       </group>
    </groups>
</qdbapi>
```