Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Get list of fields

GET

https://example.kaiten.ru/api/latest/company/custom-directories/{directory_id}/fields

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 fields ordered by sort_order ascending. There is no limit/offset pagination on this endpoint. Equal sort_order values have no unique tie-breaker.

Path parameters

Name	Type	Reference
directory_idrequired	string	Directory ID

Headers

Name	Value
Content-Type	application/json

Query

Name	Type	Constraints	Description
include_author	boolean		Include author user object
conditions	array of strings		Filter by active, inactive or removed. Default: active and inactive. Example: conditions[]=active&conditions[]=inactive

Responses

200

401

404

200

Description	Response type	Example
Success	Array of objects	Open

Response Attributes

Name	Type	Description
id	string	Field ID (UUID)
name	string	Field name
type	enum	Field type
required	boolean	Required flag
is_display	boolean	Display field flag

401

Description	Response type	Example
Invalid token	String	Open

404

Description	Response type	Example
Not found	Object	Open

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

Company domain

Path Parameters

directory_id

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

Response

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