Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Get field

GET

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

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.

Path parameters

Name	Type	Reference
directory_idrequired	string	Directory ID
field_idrequired	string	Field ID

Headers

Name	Value
Content-Type	application/json

Responses

200

401

404

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	string	Field ID (UUID)
custom_directory_id	string	Directory ID (UUID)
name	string	Field name
type	enum	Field type
custom_property_uid	null \| string	Custom property UID (for select/user/catalog fields)
linked_directory_id	null \| string	Linked directory ID (for directory_link fields)
author	object	Author user object
linkedDirectory	object	Linked directory object (for directory_link fields)
customProperty	object	Custom property object (for select/user/catalog fields)

401

Description	Response type	Example
Invalid token	String	Open

A schema has not been defined for this response code.

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

Company domain

Path Parameters

directory_id

field_id

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

Response

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