Get custom sections for editing

GET/api/crm/v2/team.edit_permission_sections_customv2

operationId: team.editPermissionSectionsCustom

Authorization

api-token + language + role

Query parameters

user_idintegerrequired

User ID; the role is determined by it

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

default_permissionsarray of object

Default role sections

idintegerrequired

Example: 572

permission_section_idintegerrequired

Example: 112

readonly_enabledbooleanrequired

Example: false

slugstringrequired

Example: branches

user_permissionsarray of object

User custom sections

idintegerrequired

Example: 572

permission_section_idintegerrequired

Example: 112

readonly_enabledbooleanrequired

Example: false

slugstringrequired

Example: branches

date_expirationoneOfcan be null

Access expiration date in UTC; null means unlimited. Expired records are deleted automatically.

One of the options

string (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

selectable_permissionsarray of object

Sections that the editor can select: the default sections of the editable role, as well as the editor's default and custom sections

idintegerrequired

Example: 1

slugstringrequired

Example: items

descriptionstringrequired

Example: Items

typestringrequired

Values:folderpagelink

Example: page

endpoint_only_enabledboolean

For type page only: the section exists as an API endpoint and is not displayed in the sidebar menu. Access is granted and checked as for a regular page, so the section remains in the role and user permission directories.

Example: false

firm_section_parent_idinteger

Example: 1

system_section_parent_idinteger

Example: 1

affiliate_section_parent_idinteger

Example: 1

sortintegerrequired

Example: -1714739780

zonestring

Example: ru

permission_condition_idinteger

Condition under which the section is displayed

Example: 2

actionsarray of object

Section actions

idinteger

Example: 1

permission_section_idinteger

Example: 62

permission_condition_idinteger

Example: 1

actionstring

Example: view

descriptionstring

Example: view

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/team.edit_permission_sections_custom?user_id=1', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'en', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/team.edit_permission_sections_custom?user_id=1", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "en", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/team.edit_permission_sections_custom?user_id=1", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "en", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "default_permissions": [ { "id": 572, "permission_section_id": 112, "readonly_enabled": false, "slug": "branches" } ], "user_permissions": [ { "id": 572, "permission_section_id": 112, "readonly_enabled": false, "slug": "branches", "date_expiration": "2024-05-02 08:31:16" } ], "selectable_permissions": [ { "id": 1, "slug": "items", "description": "Items", "type": "page", "endpoint_only_enabled": false, "firm_section_parent_id": 1, "system_section_parent_id": 1, "affiliate_section_parent_id": 1, "sort": -1714739780, "zone": "ru", "permission_condition_id": 2, "actions": [ { "id": 1, "permission_section_id": 62, "permission_condition_id": 1, "action": "view", "description": "view" } ] } ] } }