Get

[POST] .../v1/targetsetting/get

Returns target settings. Use this method to read settings attached to a target before editing target filters or showing the configured scope. The request must identify target_id and may additionally filter by setting IDs or setting type. The response returns non-deleted TargetSetting records available in the current request context and write permissions are checked by the methods that add or delete settings. Missing body, missing target_id, invalid filters and storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
id int Setting IDs used to narrow the returned settings.
target_id int Target ID. This value is required by TargetSetting/Get.
type string Target setting type used to narrow the returned settings: Item, ItemGroup, Pipeline or DealType.

Request Example

{
  "filters": [
    {
      "Field": "target_id",
      "Operator": "Equal",
      "Value": "12"
    },
    {
      "Field": "type",
      "Operator": "Equal",
      "Value": "Item"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of TargetSetting Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 31,
      "target_id": 12,
      "type": "Item",
      "value": "145",
      "include": true,
      "last_update": 1712345600
    }
  ]
}