API Documentation
- v1
- API Documentation
- How to Get Your API Tokens
- Authentication
- GETGet Company
- GETQuery Products
- GETGet Product
- POSTCreate Product
- POSTEdit Product
- GETDelete Product
- GETQuery Roles
- GETGet Role
- GETQuery Consultations
- GETGet Consultation
- POSTCreate Consultation
- POSTEdit Consultation
- GETQuery Assignments
- GETGet Assignment
- POSTCreate Assignment
- POSTAssign Assignment
- POSTEdit Assignment
- GETDelete Assignment
- GETQuery Clients
- GETGet Client
- POSTCreate Client
- POSTEdit Client
- GETDelete Client
- GETQuery Personnel
- GETGet Personnel
- POSTCreate Personnel
- POSTEdit Personnel
- GETDelete Personnel
v1
Get Role
Retrieves single role
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
API token provided to your company
Response
200
application/json
OK Response
The response is of type object
.
Was this page helpful?
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
}
Assistant
Responses are generated using AI and may contain mistakes.