---
title: "API_GetRoleInfo"
slug: "api-getroleinfo"
updated: 2025-08-18T09:23:52Z
published: 2025-08-18T09:23:52Z
canonical: "help.quickbase.com/api-getroleinfo"
---

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

**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_GetRoleInfo to get all of the roles that apply to the application. You invoke this call on the application-level dbid.

The access level returned in the field is one of these available access types:

- Basic Access (able to view/add/modify records, depending on permissions)
- Basic Access with Share (same as Basic, but can share the application with other users)
- Administrator (full administrative access)

## Request parameters

| Parameter | Value | Required? |
| --- | --- | --- |
| ticket | A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. | yes, one of: - ticket - username/password - user 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: - ticket - username/password - user token |
| apptoken | A valid application token | yes, if the application requires application tokens |
| 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_GetRoleInfo. |
| 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. |
| roles | An aggregate containing one or more roles, structured as follow`<roles>` ` <role id="11">` `      <name>Participant</name>` `      <access id="3">Basic Access</access>` `   </role>` `</roles>` Each role returned has a role ID as an attribute and contains a role name and the application access level that is conferred by the role. |
| udata | Optional. A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. |

## Sample XML Request

```xml
POST https://target_domain/db/target_dbid HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_GetRoleInfo

<qdbapi>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
</qdbapi>
```

## URL alternative

```plaintext
https://target_domain/db/target_dbid?a=API_GetRoleInfo
&apptoken=auth_token
```

where *target_domain* is the domain against which you are invoking this call, for example, *quickbase.com*. [Read about this notation](/v1/docs/understanding-the-api-call-reference).

## Sample response

```xml
<?xml version="1.0" ?>
<qdbapi>
   <action>API_GetRoleInfo</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <roles>
      <role id="10">
         <name>Viewer</name>
         <access id="3">Basic Access</access>
      </role>
      <role id="11">
         <name>Participant</name>
         <access id="3">Basic Access</access>
      </role>
      <role id="12">
         <name>Administrator</name>
         <access id="1">Administrator</access>
      </role>
   </roles>
</qdbapi>
```