API V2 Route: Roles

Last updated: October 5, 2026

General Details:

Endpoint

/api/v2/roles and /api/v2/roles/<id>

Headers

Authorization: <JWT>

HTTP Methods

GET

Request Body Format

N/A

Response Body Format

JSON

Required Scopes

ROLES_GET

 

Supported Request Filters:

These filters should be query parts in the URL string and follow the standard pattern of <baseUrl>?<key>=<filter>&...

Field Name

Filter Type

Notes

name

string or String Filter

 

 

API Response:

Field Name

Data Type

Notes

id

string

Globally unique identifier

name

string

Unique name of Role

permissions

string array

List of Permissions

isSuperAdmin

boolean

Flag to indicate if the Role is a system managed role

 

Example Response:

{
	"entities": [
		{
			"id": "1",
			"name": "RD",
			"permissions": [
				"reportingAccess",
				"profileAccess",
				"profileEdit",
				"profileMerge",
				"contactInfo",
				"tagsManagement",
				"profileTagsEdit",
				"residencies",
				"keys",
				"notes",
				"eSignatureDocuments",
				"additionalForms",
				"attachments",
				"appAccess",
				"appReview",
				"appStatusReview",
				"appContactInfo",
				"appTags",
				"appTag",
				"appAssignments",
				"appData",
				"appForms",
				"appBio",
				"appSinables",
				"appPayments",
				"appPaymentsEdit",
				"appNotes",
				"appCheckList",
				"appStatus",
				"appAddForms",
				"appInvite"
			],
			"isSuperAdmin": false
		},
		{
			"id": "2",
			"name": "IT",
			"permissions": [
				"integrationsAccess",
				"integrationsConfigAccess",
				"integrationsManualImport"
			],
			"isSuperAdmin": false
		}
	],
	"metaData": {
		"agentId": "634afe7e-b41d-470e-98c1-c9fb147e7226",
		"rateLimits": {
			"tenant": {
				"limit": 50,
				"remaining": 49,
				"reset": 1761074083000
			},
			"agent": {
				"limit": 10,
				"remaining": 9,
				"reset": 1761074083000
			}
		},
		"pagination": {
			"offset": 0,
			"limit": 1000
		}
	}
}