PApartoo
Custom Roles

Get Custom Role

Get the details of a specific Custom Role.

get/custom_role/{custom_role_api_id}

Request

Path parameters

custom_role_api_idstring required

API identifier of the custom role (api_id)

Query parameters

org_idinteger

Organization ID. Only PROVIDER users can specify a different organization. If not provided, defaults to your own organization.

Response

OK

namestring

Name of the Custom Role. Cannot contain any of the following characters: ,;/\|<>.

api_idstring

API identifier of the Custom Role. Cannot contain any of the following characters: ,;/\|<>.

descriptionstring
org_idinteger

Unique identifier of an organization in Partoo.

is_builtinboolean
permissionsstring[]

Example response

{
  "name": "This is My Custom Role",
  "api_id": "this_is_my_custom_role",
  "description": "It has a custom permission configuration!",
  "org_id": 42,
  "permissions": [
    "business_edit",
    "business_edit_open_hours"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.