Get list of records
Returns records ordered by created descending before limit/offset. Equal timestamps have no unique tie-breaker; offset pagination cannot guarantee a complete, duplicate-free export. Default and maximum limit: 100. A non-empty query takes precedence over filters; the two searches are not combined.
Pass filters as nested query parameters, for example filters[0][fieldId]=c1d2e3f4-1111-4aaa-8bbb-ccccdddd0001&filters[0][fieldType]=string&filters[0][comparison]=contains&filters[0][value]=Alice (URL-encode the parameter names and values). A JSON string or Base64 string is not parsed by this endpoint. fieldId is the field UUID and fieldType must match it. Text comparisons: eq, ne, contains, not_contains, starts_with, ends_with, known, unknown. Number/date: eq, ne, gt, lt, known, unknown. Checkbox: true, false. Select/user/catalog/directory_link: eq, ne, known, unknown. File: known, unknown. For select/user/catalog, searchByDisplayValue=true compares display text instead of UID and also supports contains; omit this parameter to search by UID. Unsupported comparisons are ignored, not rejected; do not rely on filters as an access-control boundary.
| 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. Default: 0 | |
| query | string | Case-insensitive substring search across text values, numbers converted to text, user full names, select labels and catalog value names. Does not search only display_value. Takes precedence over filters. | |
| profile | string | none | summary | details | full | none excludes values; summary includes values and direct relations; details also expands linked-record values and directory fields; full adds the next linked-record level. An explicit recognized profile overrides include_values. With no recognized profile, values are omitted unless include_values=true. Does not control include_author. |
| include_values | boolean | Default: false. Includes the full values relation graph only when no recognized profile is supplied. | |
| include_author | boolean | Include author user object | |
| conditions | array of strings | Filter by active, inactive or removed. Default: active only. Example: conditions[]=active&conditions[]=inactive | |
| filters | array of objects | Nested query parameters containing fieldId, fieldType, comparison, value and optional searchByDisplayValue. See the filter format above. Do not serialize the array as a JSON string. Ignored when query is non-empty. | |
| 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 |
| 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.ru
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!