---
title: "List Spend Controls"
method: GET
path: "/spend_controls"
tags: ["Spend Controls"]
---

# List Spend Controls

`GET /spend_controls`

List spend controls

## Query parameters

- `amount_limit_gte` integer
- `amount_limit_lte` integer
- `scope` 'ACCOUNT' | 'BANK' | 'FINTECH' — The scope of the spend control
- `num_related_accounts_gte` integer
- `num_related_accounts` integer
- `num_related_accounts_lte` integer
- `sort_by` string[]
- `payment_type` 'ACH' | 'CARD' | 'CASH' | 'CHECK' | 'EFT_CA' | 'EXTERNAL_CARD' | 'INTERNAL_TRANSFER' | 'SYNCTERA_PAY' | 'WIRE' — The type of payment to which a spend control applies. If this is not set, the spend control applies to all spending, regardless of payment type.
- `name` string
- `id` string[]
- `direction` 'CREDITS' | 'DEBITS' — The direction of funds flow to which a spend control applies. To limit the rate of funds flowing out of an account, use DEBIT. To limit the rate of funds flowing in to an account, use CREDIT. If this is not set, the spend control applies to debits (ie spending) only.
- `is_active` boolean
- `limit` integer — Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.
- `account_id` string, uuid
- `amount_limit` integer

## Response `200`

Spend control details

- SpendControlResponseList
  - `spend_controls` SpendControlResponse[], required — Array of Spend Controls
    - `number_of_related_accounts` integer, required — A count of how many accounts are using this spend control
    - `action_case` boolean, required — If set, create a case for transactions that do not conform to the spend control
    - `action_decline` boolean, required — If set, decline transactions that do not conform to the spend control
    - `amount_limit` integer, required — Monetary limit for the spend control in the smallest currency unit (eg cents)
    - `creation_time` string, date-time, required — The timestamp representing when the spend control was created
    - `direction` 'CREDITS' | 'DEBITS' — The direction of funds flow to which a spend control applies. To limit the rate of funds flowing out of an account, use DEBIT. To limit the rate of funds flowing in to an account, use CREDIT. If this is not set, the spend control applies to debits (ie spending) only.
    - `id` string, uuid, required — Spend Control ID
    - `is_active` boolean, required — Indicates if spend control is active
    - `last_modified_time` string, date-time, required — The timestamp representing when the spend control was last modified
    - `merchant_category_codes` string[] — merchant category codes for spend control
    - `name` string, required — Name assigned to spend control
    - `payment_sub_types` string[] — A list of payment sub-types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all sub-types.
    - `payment_types` PaymentType[] — A list of payment types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all types of payments.
    - `scope` 'ACCOUNT' | 'BANK' | 'FINTECH', required — The scope of the spend control
    - `time_range` union, required — The time range to which the spend control applies
      - SpendControlTimeRangeType
        - `time_range_type` 'FOREVER' | 'ROLLING_WINDOW_DAYS' | 'SINGLE_TRANSACTION', required
      - SpendControlTimeRangeType
        - `time_range_type` 'FOREVER' | 'ROLLING_WINDOW_DAYS' | 'SINGLE_TRANSACTION', required
      - object
        - `days` integer, required — The number of days to define a rolling window for a spend control
        - `time_range_type` 'FOREVER' | 'ROLLING_WINDOW_DAYS' | 'SINGLE_TRANSACTION', required
  - `next_page_token` string — If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden error
- `422` — Unprocessable entity request response
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/versions/b0d812e6cdd0/schema)