Skip to main content
GET
/
roles
List Roles
curl --request GET \
  --url https://api.{your-broker}.slate-labs.com/roles
[
  {
    "id": 123,
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "customer_scope": "<string>",
    "customer_access": "<string>",
    "customer_view_scope": "<string>",
    "customer_edit_scope": "<string>",
    "pii_email": "<string>",
    "pii_phone": "<string>",
    "can_export_pii": true,
    "level": 123,
    "is_system": true,
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Query Parameters

include_inactive
boolean
default:false

Response

Successful Response

id
integer
required
name
string
required
display_name
string
required
description
string | null
required
customer_scope
string
required
customer_access
string
required
customer_view_scope
string
required
customer_edit_scope
string
required
pii_email
string
required
pii_phone
string
required
can_export_pii
boolean
required
level
integer
required
is_system
boolean
required
is_active
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required