devguard
Business roles

Get a list of paginated business roles.

GET
/business-roles/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

limit?number
Range5 <= value <= 100
Default100
page?number
Range1 <= value
Default1
organizationId*string
Length1 <= length
orderByName?string

Value in

  • "asc"
  • "desc"
filterByName?string
filterByArchived?string
Default"active"

Value in

  • "active"
  • "archived"
includeResponsibilities?boolean
Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/business-roles/?organizationId=string"
{  "items": [    {      "id": "string",      "slug": "string",      "name": "string",      "description": "string",      "archivedAt": "string",      "organizationId": "string",      "users": [        "string"      ],      "responsibilities": {        "vendors": -9007199254740991,        "risks": -9007199254740991,        "assets": -9007199254740991,        "treatmentActions": -9007199254740991,        "policiesToApprove": -9007199254740991,        "evidence": -9007199254740991,        "evidenceToApprove": -9007199254740991,        "incidents": -9007199254740991,        "trainings": -9007199254740991,        "processes": -9007199254740991,        "recordCategories": -9007199254740991,        "records": -9007199254740991,        "tasks": -9007199254740991,        "securityQuestionnaires": -9007199254740991,        "riskReviewsToCoordinate": -9007199254740991,        "assetReviewsToCoordinate": -9007199254740991,        "vendorReviewsToCoordinate": -9007199254740991,        "entitlementReviewsToCoordinate": -9007199254740991,        "vendorAssessmentsToPerform": -9007199254740991,        "assignments": -9007199254740991      }    }  ],  "total": 0,  "page": 0,  "limit": 0}

How is this guide?