Developer Portal
  • Introduction
  • API Endpoint
  • Authentication
  • Errors
  • Rate Limiting
  • Pagination
  • Request IDs
  • API reference
    • Partner portals
      • Users
    • User attributes
    • Roles
    • Warehouses
      • Persistence Engine
Powered by GitBook
On this page

Was this helpful?

  1. API reference

Roles

PreviousUser attributesNextWarehouses

Last updated 10 months ago

Was this helpful?

get
Authorizations
Query parameters
afterstringOptional
limitnumberOptional
Responses
200Success
application/json
Responseall of
and
get
GET /v1/roles HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "paging": {
    "next": {
      "after": "text"
    }
  },
  "data": [
    {
      "id": "text",
      "name": "text",
      "is_system": true
    }
  ]
}
get
Authorizations
Path parameters
roleIdstringRequired
Responses
200Success
application/json
get
GET /v1/roles/{roleId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "text",
  "name": "text",
  "is_system": true
}
  • GET/v1/roles
  • GET/v1/roles/{roleId}