---
title: "API_AddUserToGroup"
slug: "api-addusertogroup"
updated: 2025-08-18T09:02:27Z
published: 2025-08-18T09:02:27Z
canonical: "help.quickbase.com/api-addusertogroup"
---

> ## 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_AddUserToGroup

**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_AddUserToGroup to add a user to a group. The user can be added as a member of the group, as a member and a manager of the group, or as a manager but not a member of the group.

## Request parameters

| Parameter | Value | Required? |
| --- | --- | --- |
| gid | The id of the group to manage. | yes |
| uid | The id of the Quickbase user to add to the group. | yes |
| email | The email of the Quickbase user | no |
| screenName | The screen name of the Quickbase user, if set | no |
| allowAdminAccess | Whether the user should be added as an admin of the group. 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_AddUserToGroup. |
| 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. |

## Sample XML Request

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

<qdbapi>
   <udata>misc data</udata>
   <ticket>auth_ticket</ticket>
   <gid>345889.sdfd</gid>
   <uid>898790.qntp</uid>
   <allowAdminAccess>true</allowAdminAccess>
</qdbapi>
```

## Sample HTTP Get Request

```plaintext
https://target_domain/db/main?a=API_AddUserToGroup&gid=345889.sdfd&uid=898790.qntp&
allowAdminAccess=true&ticket=auth_ticket&udata=misc%20data
```

## Sample response

```xml
<?xml version="1.0" ?>
<qdbapi>
   <action>API_AddUserToGroup</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <udata>misc data</udata>
</qdbapi>
```