curl --request GET \
--url https://api.partoo.co/v2/permissions \
--header 'x-APIKey: <api-key>'{
"sections": [
{
"name": "presence",
"order": 100,
"subsections": [
{
"name": "presence_pages",
"order": 100,
"permissions": [
{
"name": "business_edit",
"order": 100,
"feature": "business_edition",
"depends_on": null,
"disabled_for_roles": []
},
{
"name": "business_edit_name",
"order": 101,
"feature": "business_edition",
"depends_on": "business_edit",
"disabled_for_roles": []
}
]
}
]
}
]
}This endpoint will give you all of the permissions available to your organization. The permissions are categorized by section, and by subsection. The permissions available to your organization are based on the plans your organization subscribes to; and thus the features included in those plans.
curl --request GET \
--url https://api.partoo.co/v2/permissions \
--header 'x-APIKey: <api-key>'{
"sections": [
{
"name": "presence",
"order": 100,
"subsections": [
{
"name": "presence_pages",
"order": 100,
"permissions": [
{
"name": "business_edit",
"order": 100,
"feature": "business_edition",
"depends_on": null,
"disabled_for_roles": []
},
{
"name": "business_edit_name",
"order": 101,
"feature": "business_edition",
"depends_on": "business_edit",
"disabled_for_roles": []
}
]
}
]
}
]
}The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.
OK
Response when permissions are successfully retrieved
Show child attributes
"presence"
100
Show child attributes
"presence_pages"
100
Show child attributes
Permission internal name
"business_edit"
Ordering value used by the UI
100
Feature flag or product feature that gates this permission
"business_edition"
If present, identifies the permission(s) that must also be granted for a user to have this permission.
"business_edit"
List of api_ids of roles for which this permission is disabled
[]Was this page helpful?