Get

[POST] .../v1/connectedintegrationsetting/get

Returns settings for a connected integration. Retrieve settings for a connected integration before calling ConnectedIntegrationSetting/Edit. Select the integration with a connected_integration_id filter; provide firm_id through filters for firm-owned settings. Returns setting keys, values and last_update timestamps. The caller must have integration select access. Missing body or identifier, invalid filters, unresolved integration, missing firm settings, denied access and storage failures return HTTP 200 ErrorResult.

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
connected_integration_id string Connected integration ID. Takes precedence over integration_key when both fields are provided.
firm_id int Company ID.
integration_key string Deprecated field. Integration key, which is the system name. If passed together with connected_integration_id, connected_integration_id is used.

Request Example

{
  "filters": [
    {
      "field": "connected_integration_id",
      "operator": "Equal",
      "value": "c98210addc4f4e1bb50b17a8c1299a37"
    },
    {
      "field": "firm_id",
      "operator": "Equal",
      "value": "1"
    }
  ]
}

Response Parameters

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

Response Example

{
  "ok": true,
  "result": [
    {
      "key": "order_from_id",
      "value": "15",
      "last_update": 1712345678
    },
    {
      "key": "price_type",
      "value": "2",
      "last_update": 1712345680
    }
  ]
}