Skip to main content
GET
/
admin
/
roles
/
list
List Roles
curl --request GET \
  --url https://api.decodahealth.com/admin/roles/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "userType": "ADMIN",
    "createdDate": "2023-11-07T05:31:56Z",
    "updatedDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "permissions": [
      "<string>"
    ]
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Response

200 - application/json

Successful Response

​
id
string
required

Unique identifier for the role

​
name
string
required

Role name (e.g., 'admin', 'user', 'billing_manager')

​
userType
enum<string>
required

Role type (ADMIN, PROVIDER, USER)

Available options:
ADMIN,
PROVIDER,
USER
​
createdDate
string<date-time> | null

When the role was created

​
updatedDate
string<date-time> | null

When the role was last updated

​
description
string | null

Description of what this role does

​
permissions
string[]

List of permission strings