​
Get list of select values
GET
https://example.kaiten.ru/api/latest/company/custom-properties/{property_id}/select-valuesGet custom property select values list. The result of the request is displayed page by page if v2_select_search is true (see details in the constraints of the parameters).
| Name | Type | Reference |
|---|---|---|
| property_idrequired | integer | CustomProperty ID |
| Name | Type | Constraints | Description |
|---|---|---|---|
| v2_select_search | boolean | Parameter that enables additional filtering | |
| query | string | Filter by select value. Works only if v2_select_search param is true | |
| order_by | string | Field to sort by. Works only if v2_select_search param is true | |
| ids | array | Array of ids to filter by. Works only if v2_select_search param is true | |
| conditions | array | Array of conditions to filter by. Works only if v2_select_search param is true | |
| offset | integer | Number of records to skip. Works only if v2_select_search param is true | |
| limit | integer | Default: 100 | Maximum amount of values in response. Works only if v2_select_search param is true |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Array of object |
| Name | Type | Description |
|---|---|---|
| id | integer | Select option id |
| custom_property_id | integer | Custom property id |
| value | string | Select option value |
| color | integer | Color number |
| condition | string | Custom property select value condition |
| sort_order | number | Position |
| external_id | null | string | External id |
| updated | string | Last update timestamp |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Forbiden | Response body does not exist |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Not found | Object |
| Name | Type | Description |
|---|---|---|
| message | string | Error message |
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-properties/{property_id}/select-values' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json'
5 Response
ClickTry It!to start a request and see the response here!