​
Get list of custom property tree entities
GET
https://example.kaiten.ru/api/latest/company/custom-properties/{property_id}/tree-entities| Name | Type | Reference |
|---|---|---|
| property_idrequired | integer | Custom property ID |
| Name | Value |
|---|---|
| Content-Type | application/json |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Object |
| Name | Type | Description |
|---|---|---|
| uid | string | Entity uid |
| title | string | Entity title |
| sort_order | number | Entity sort order |
| archived | boolean | Archived flag |
| access | string | Entity access |
| for_everyone_access_role_id | string | Role id for when access is for_everyone |
| entity_type | string | Entity type |
| path | string | Inner path to entity |
| parent_entity_uid | string | Parent entity uid |
| company_id | integer | Company id |
| protected | boolean | Flag that disables the display of an element in the sidebar |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Tariff must include "custom properties usage paths" feature | Object | Response body does not exist |
| Name | Type | Description |
|---|---|---|
| featurePath | string | Feature path in company.features object |
| message | string | Error message |
| Description | Response type | Example |
|---|---|---|
| Forbidden | Response body does not exist |
A schema has not been defined for this response code.
Kaiten
If you have any questions or need help with integration feel free to write us at support@kaiten.io
Path Parameters
1 curl --request GET \
2 --url 'https://example.kaiten.ru/api/latest/company/custom-properties/{property_id}/tree-entities' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json'
5 Response
ClickTry It!to start a request and see the response here!