Roles & Permissions

API Endpoints for Roles and Permissions

• List Roles
• Retrieve Role
• Create Role
• Update Role
• Delete Role
• Retrieve Permissions

List Roles get

https://relatecrm.example.com/api/roles

Headers Required headers

Content-Type (Required)	string	application/json
Accept (Required)	string	application/json
Authorization (Required)	string	Bearer {token}

Retrieve Role get

https://relatecrm.example.com/api/roles/{id}

Headers Required headers

Content-Type (Required)	string	application/json
Accept (Required)	string	application/json
Authorization (Required)	string	Bearer {token}

Path Parameters

id (Required)	integer	The ID of the record

Create Role post

https://relatecrm.example.com/api/roles

Headers Required headers

Content-Type (Required)	string	application/json
Accept (Required)	string	application/json
Authorization (Required)	string	Bearer {token}

Body Parameters

name (Required)	string
permissions (Optional)	array	Array of role permissions Example: [ "view own activities", "delete own activities", "view own companies", "edit own companies", ]

Update Role put

https://relatecrm.example.com/api/roles/{id}

Headers Required headers

Content-Type (Required)	string	application/json
Accept (Required)	string	application/json
Authorization (Required)	string	Bearer {token}

Path Parameters

id (Required)	integer	The ID of the record

Body Parameters

name (Required)	string
permissions (Optional)	array	Array of role permissions Example: [ "view own activities", "delete own activities", "view own companies", "edit own companies", ]

Delete Role delete

https://relatecrm.example.com/api/roles/{id}

Headers Required headers

Content-Type (Required)	string	application/json
Accept (Required)	string	application/json
Authorization (Required)	string	Bearer {token}

Path Parameters

id (Required)	integer	The ID of the record

Retrieve Permissions get

https://relatecrm.example.com/api/permissions

Headers Required headers

Content-Type (Required)	string	application/json
Accept (Required)	string	application/json
Authorization (Required)	string	Bearer {token}