---
title: "Get user states for a multi-user budget"
method: GET
path: "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states"
tags: ["billing"]
---

# Get user states for a multi-user budget

`GET /enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states`

Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.

## Path parameters

- `enterprise` string, required
- `budget_id` string, required

## Query parameters

- `page` integer
- `per_page` integer
- `sort_order` '0' | '1'
- `user` string
- `threshold_lower_bound` integer
- `threshold_upper_bound` integer

## Response `200`

Response when getting per-user states for a multi-user budget

- GetBudgetUserStates
  - `user_states` object[], required — Per-user state entries for the budget.
    - `user` string — The login of the user, when the user record is available.
    - `consumed_amount` number, required — The amount currently consumed by this user against the budget.
    - `target_amount` number, required — The target amount allocated to this user within the budget.
    - `override_budget_id` string — The ID of a user-scoped budget that overrides the per-user allocation, when present.
  - `has_next_page` boolean, required — Indicates if there are more pages of results available.
  - `total_count` integer, required — Total number of user state entries matching the query.

## Other responses

- `403` — Forbidden
- `404` — Resource not found
- `500` — Internal Error
- `503` — Service unavailable

---

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