---
title: "Get budgets"
method: GET
path: "/v1/budgets"
tags: ["budgetManagement"]
---

# Get budgets

`GET /v1/budgets`

Get budgets

## Query parameters

- `limit` integer
- `token` string

## Response `200`

Budgets assigned to the org.

- ScanBudgetList
  - `data` ScanBudget[], required — List of scan budgets.
    - `name` string, required — Name of the budget.
    - `capacity` integer, required — Capacity of the budget.
    - `unit` string, required — Unit of the budget.
    - `budgetType` string, required — Type of the budget.
    - `scope` ScanBudgetScope, required
      - `includedUsers` string[], required — List of userIds included in the budget.
      - `excludedUsers` string[], required — List of userIds excluded in the budget.
      - `includedRoles` string[], required — List of roleIds included in the budget.
      - `excludedRoles` string[], required — List of roleIds excluded in the budget.
    - `window` string, required — Window of the budget. Use Daily/Weekly/Monthly for creating a time based budget (beta)
    - `applicableOn` string, required — Grouping of the budget.
    - `groupBy` string, required — Grouping Entity of the budget.
    - `action` string, required — Action to be taken if the budget is breached
    - `status` string — Signifies the state of the budget. (Active/Inactive)
    - `id` string, required — Id of the budget.
    - `orgId` string, required — Org Id of the org for the budget.
    - `resetTime` string, required — Reset time of the time based scan budget in HH:MM format
    - `resetTimeZone` string, required — Time zone of the reset time for the time based scan budget. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
    - `resetDayOfWeek` string, required — The day of the week when the budget resets, applicable for time based budgets with a Weekly window. Must be a valid day of the week.
    - `resetDateOfMonth` integer, required — The date of the month when the budget resets, applicable for time based budgets with a Monthly window. Must be a valid day of the month (1-28).
    - `createdAt` string, date-time, required — Date & time when budget was created.
    - `createdBy` string, required — Id of the user who created the budget.
    - `modifiedAt` string, date-time, required — Date & time when budget was last modified.
    - `modifiedBy` string, required — Id of the user who last modified the budget.
  - `next` string — Next continuation token.

## Other responses

- `default` — Operation failed with an error.

---

[API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/revisions/18a824df1e78/schema)
