​
Get list of records
GET
https://example.kaiten.ru/api/latest/company/custom-directories/{directory_id}/recordsReturns records list. Use `profile` query param (recommended) to control included relations. Limit is capped at 100.
| Name | Type | Reference |
|---|---|---|
| directory_idrequired | string | Directory ID |
| Name | Value |
|---|---|
| Content-Type | application/json |
| Name | Type | Constraints | Description |
|---|---|---|---|
| limit | number | Default: 100 Max: 100 | Maximum number of records in response |
| offset | number | Number of records to skip | |
| query | string | Quick search by record display value | |
| profile | string | none | summary | details | full | Controls included relations in response |
| include_values | boolean | Legacy: include values array | |
| include_author | boolean | Include author user object | |
| conditions | array of strings | Filter by condition values: active | inactive | removed | |
| filters | object | Advanced field-based filters (JSON) | |
| filter_operator | string | and | or | Boolean operator for filters (default: and) |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Array of objects |
| Name | Type | Description |
|---|---|---|
| id | string | Record ID (UUID) |
| display_value | null | string | Pre-computed record display value |
| condition | enum | Record condition |
| values | array of objects | Field values (included depending on profile/include_values) |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Not found | Object |
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-directories/{directory_id}/records' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json'
5 Response
ClickTry It!to start a request and see the response here!