GET
/
role
/
get
/
{company_slug}
/
{role_id}
curl --request GET \
  --url https://api.hierarch.io/v1/role/get/{company_slug}/{role_id}/ \
  --header 'token: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "can_view_company": true,
  "can_view_allrole": true,
  "can_view_role": true,
  "can_create_role": true,
  "can_edit_role": true,
  "can_delete_role": true,
  "can_view_allproduct": true,
  "can_view_product": true,
  "can_create_product": true,
  "can_edit_product": true,
  "can_delete_product": true,
  "can_view_allconsultation": true,
  "can_view_consultation": true,
  "can_create_consultation": true,
  "can_edit_consultation": true,
  "can_delete_consultation": true,
  "can_view_allpipeline": true,
  "can_view_pipeline": true,
  "can_create_pipeline": true,
  "can_edit_pipeline": true,
  "can_delete_pipeline": true,
  "can_view_allclient": true,
  "can_view_client": true,
  "can_create_client": true,
  "can_edit_client": true,
  "can_delete_client": true,
  "can_view_allticket": true,
  "can_view_ticket": true,
  "can_create_ticket": true,
  "can_edit_ticket": true,
  "can_delete_ticket": true,
  "can_view_allpersonnel": true,
  "can_view_personnel": true,
  "can_create_personnel": true,
  "can_edit_personnel": true,
  "can_delete_personnel": true,
  "can_view_allhandbook": true,
  "can_view_handbook": true,
  "can_create_handbook": true,
  "can_edit_handbook": true,
  "can_delete_handbook": true,
  "can_view_allassignment": true,
  "can_view_assignment": true,
  "can_create_assignment": true,
  "can_edit_assignment": true,
  "can_delete_assignment": true,
  "can_view_allannouncement": true,
  "can_view_announcement": true,
  "can_create_announcement": true,
  "can_edit_announcement": true,
  "can_delete_announcement": true,
  "can_view_allmemo": true,
  "can_view_memo": true,
  "can_create_memo": true,
  "can_edit_memo": true,
  "can_delete_memo": true,
  "can_view_allleave": true,
  "can_view_leave": true,
  "can_create_leave": true,
  "can_edit_leave": true,
  "can_delete_leave": true,
  "can_view_notebox": true,
  "can_create_notebox": true,
  "can_edit_notebox": true,
  "can_delete_notebox": true,
  "can_view_allreview": true,
  "can_view_review": true,
  "can_create_review": true,
  "can_edit_review": true,
  "can_delete_review": true,
  "can_view_allform": true,
  "can_view_form": true,
  "can_create_form": true,
  "can_edit_form": true,
  "can_delete_form": true,
  "can_view_allworkflow": true,
  "can_view_workflow": true,
  "can_create_workflow": true,
  "can_edit_workflow": true,
  "can_delete_workflow": true
}

Authorizations

token
string
header
required

API token provided to your company

Path Parameters

company_slug
string
required

This is your company url

role_id
string
required

Role ID

Response

200
application/json
OK Response
id
integer
required

Role ID

name
string

Role name

description
string

Role description

can_view_company
boolean

true if role has access

can_view_allrole
boolean

true if role has access

can_view_role
boolean

true if role has access

can_create_role
boolean

true if role has access

can_edit_role
boolean

true if role has access

can_delete_role
boolean

true if role has access

can_view_allproduct
boolean

true if role has access

can_view_product
boolean

true if role has access

can_create_product
boolean

true if role has access

can_edit_product
boolean

true if role has access

can_delete_product
boolean

true if role has access

can_view_allconsultation
boolean

true if role has access

can_view_consultation
boolean

true if role has access

can_create_consultation
boolean

true if role has access

can_edit_consultation
boolean

true if role has access

can_delete_consultation
boolean

true if role has access

can_view_allpipeline
boolean

true if role has access

can_view_pipeline
boolean

true if role has access

can_create_pipeline
boolean

true if role has access

can_edit_pipeline
boolean

true if role has access

can_delete_pipeline
boolean

true if role has access

can_view_allclient
boolean

true if role has access

can_view_client
boolean

true if role has access

can_create_client
boolean

true if role has access

can_edit_client
boolean

true if role has access

can_delete_client
boolean

true if role has access

can_view_allticket
boolean

true if role has access

can_view_ticket
boolean

true if role has access

can_create_ticket
boolean

true if role has access

can_edit_ticket
boolean

true if role has access

can_delete_ticket
boolean

true if role has access

can_view_allpersonnel
boolean

true if role has access

can_view_personnel
boolean

true if role has access

can_create_personnel
boolean

true if role has access

can_edit_personnel
boolean

true if role has access

can_delete_personnel
boolean

true if role has access

can_view_allhandbook
boolean

true if role has access

can_view_handbook
boolean

true if role has access

can_create_handbook
boolean

true if role has access

can_edit_handbook
boolean

true if role has access

can_delete_handbook
boolean

true if role has access

can_view_allassignment
boolean

true if role has access

can_view_assignment
boolean

true if role has access

can_create_assignment
boolean

true if role has access

can_edit_assignment
boolean

true if role has access

can_delete_assignment
boolean

true if role has access

can_view_allannouncement
boolean

true if role has access

can_view_announcement
boolean

true if role has access

can_create_announcement
boolean

true if role has access

can_edit_announcement
boolean

true if role has access

can_delete_announcement
boolean

true if role has access

can_view_allmemo
boolean

true if role has access

can_view_memo
boolean

true if role has access

can_create_memo
boolean

true if role has access

can_edit_memo
boolean

true if role has access

can_delete_memo
boolean

true if role has access

can_view_allleave
boolean

true if role has access

can_view_leave
boolean

true if role has access

can_create_leave
boolean

true if role has access

can_edit_leave
boolean

true if role has access

can_delete_leave
boolean

true if role has access

can_view_notebox
boolean

true if role has access

can_create_notebox
boolean

true if role has access

can_edit_notebox
boolean

true if role has access

can_delete_notebox
boolean

true if role has access

can_view_allreview
boolean

true if role has access

can_view_review
boolean

true if role has access

can_create_review
boolean

true if role has access

can_edit_review
boolean

true if role has access

can_delete_review
boolean

true if role has access

can_view_allform
boolean

true if role has access

can_view_form
boolean

true if role has access

can_create_form
boolean

true if role has access

can_edit_form
boolean

true if role has access

can_delete_form
boolean

true if role has access

can_view_allworkflow
boolean

true if role has access

can_view_workflow
boolean

true if role has access

can_create_workflow
boolean

true if role has access

can_edit_workflow
boolean

true if role has access

can_delete_workflow
boolean

true if role has access