Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Get list of custom directories

GET

https://example.kaiten.ru/api/latest/company/custom-directories

This endpoint is currently under active development. Parameters, attributes, and response formats are subject to change. Custom directories API is in beta and may change.

Returns directories in the authenticated company. Use query parameters to include related fields, author and records_count. Results are ordered by created descending before limit/offset.

Headers

Name	Value
Content-Type	application/json

Query

Name	Type	Constraints	Description
include_fields	boolean		Include directory fields
include_author	boolean		Include author user object
include_records_count	boolean		Include the count of active and inactive records (removed records are excluded)
limit	number	Default: 200 Max: 200	Maximum number of directories in response
offset	number		Number of directories to skip. Default: 0
query	string		Search by directory name (case-insensitive)
conditions	array of strings		Filter by active, inactive or removed. Default: active and inactive. Example: conditions[]=active&conditions[]=inactive

Responses

200

401

403

200

Description	Response type	Example
Success	Array of objects	Open

Response Attributes

Name	Type	Description
id	string	Directory ID (UUID)
name	string	Directory name
description	null \| string	Directory description
condition	enum	Directory condition: active \| inactive \| removed
settings	object	Directory settings
records_count	integer	Records count (only when include_records_count=true)
fields	array of objects	Directory fields (only when include_fields=true)
author	object	Author user object (only when include_author=true)

401

Description	Response type	Example
Invalid token	String	Open

403

Description	Response type	Example
Forbidden		Response body does not exist

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.ru

Company domain

  1  curl --request GET \
  2       --url 'https://example.kaiten.ru/api/latest/company/custom-directories' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

ClickTry It!to start a request and see the response here!