Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Get list of entities

GET

https://example.kaiten.ru/api/latest/tree-entities

This endpoint is currently under active development. Parameters, attributes, and response formats are subject to change.

Get tree entities list filtered by query parameters. The result of the request is displayed page by page (see details in the constraints of the parameters).

Headers

Name	Value
Content-Type	application/json

Query

Name	Type	Constraints	Description
limit	number	Default: 500 Max: 500	Maximum number of entities in response
offset	number		Number of records to skip
parent_entity_uid	string		Get entities that are nested in entity with desired uid
levels_count	number	max: 2	Max depth level

Responses

200

401

403

200

Description	Response type	Example
Success	Object	Open

Response Attributes

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

401

Description	Response type	Example
Invalid token	String	Open

A schema has not been defined for this response code.

403

Description	Response type	Example
Forbiden		Response body does not exist

A schema has not been defined for this response code.

Kaiten

Addons terms of use Personal data processing policy

If you have any questions or need help with integration feel free to write us at support@kaiten.io

Company domain

  1  curl --request GET \
  2       --url 'https://example.kaiten.ru/api/latest/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!