Sample - GitHub REST API
GET/organizations/{org}/settings/billing/budgets

Get all budgets for an organization

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. Each page returns up to 100 budgets.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters
orgstringrequired
The organization name. The name is not case sensitive.
pageintegeroptional
The page number of the results to fetch.
Default:1
per_pageintegeroptional
The number of results per page (max 100).
Default:10
scopestringoptional
Filter budgets by scope type. - `organization`: Budgets scoped to the organization. - `repository`: Budgets scoped to a repository. - `multi_user_customer`: Universal budgets that apply to all users in the organization. - `user`: Budgets scoped to an individual user.
Allowed:enterpriseorganizationrepositorycost_centermulti_user_customeruser
userstringoptional
Filter consumed amount details for budgets by the specified user login.

4 status codes
200Response when getting all budgets
budgetsarray<object>required
Array of budget objects for the enterprise
userstringoptional
User login included when the response is scoped with the `user` query parameter.
effective_budgetobjectoptional
Effective user-level budget details returned when the response is scoped with the `user` query parameter.
has_next_pagebooleanoptional
Indicates if there are more pages of results available (maps to hasNextPage from billing platform)
total_countintegeroptional
Total number of budgets matching the query
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
500Internal Error
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 500 is returned: Internal Error.