---
title: BudgetPrograms
editUrl: false
head: []
template: doc
prev: false
next: false
sidebar:
  hidden: false
  attrs: {}
pagefind: true
draft: false
---

Defined in: [src/budgets/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L8)

## Constructors

### Constructor

> **new BudgetPrograms**(`_core`): `BudgetPrograms`

Defined in: [src/budgets/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L9)

#### Parameters

##### \_core

[`BrexCore`](/brex/api/index/classes/brexcore/)

#### Returns

`BudgetPrograms`

## Methods

### get()

> **get**(`id`, `options?`): `Promise`\<\{ `budget_blueprints`: `object`[]; `budget_program_status`: `"BUDGET_PROGRAM_STATUS_ACTIVE"` \| `"BUDGET_PROGRAM_STATUS_INACTIVE"` \| `"BUDGET_PROGRAM_STATUS_DELETED"`; `created_at`: `string`; `creator_user_id?`: `string` \| `null`; `description?`: `string` \| `null`; `employee_filter?`: \{ `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` \| `"EMPLOYMENT_STATUS_INACTIVE"` \| `"EMPLOYMENT_STATUS_PENDING"` \| `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` \| `"EMPLOYMENT_TYPE_PART_TIME"` \| `"EMPLOYMENT_TYPE_CONTRACTOR"` \| `"EMPLOYMENT_TYPE_INTERN"` \| `"EMPLOYMENT_TYPE_FREELANCE"` \| `null`; \} \| `null`; `existing_budget_ids?`: `string`[] \| `null`; `id`: `string`; `name`: `string`; `updated_at`: `string`; \}\>

Defined in: [src/budgets/client.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L18)

Get Budget Program

Retrieves a Budget Program by ID

`GET /v1/budget_programs/{id}` — requires OAuth scope: `budgets.readonly`, `budgets`

#### Parameters

##### id

`string`

##### options?

[`RequestOptions`](/brex/api/index/interfaces/requestoptions/)

#### Returns

`Promise`\<\{ `budget_blueprints`: `object`[]; `budget_program_status`: `"BUDGET_PROGRAM_STATUS_ACTIVE"` \| `"BUDGET_PROGRAM_STATUS_INACTIVE"` \| `"BUDGET_PROGRAM_STATUS_DELETED"`; `created_at`: `string`; `creator_user_id?`: `string` \| `null`; `description?`: `string` \| `null`; `employee_filter?`: \{ `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` \| `"EMPLOYMENT_STATUS_INACTIVE"` \| `"EMPLOYMENT_STATUS_PENDING"` \| `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` \| `"EMPLOYMENT_TYPE_PART_TIME"` \| `"EMPLOYMENT_TYPE_CONTRACTOR"` \| `"EMPLOYMENT_TYPE_INTERN"` \| `"EMPLOYMENT_TYPE_FREELANCE"` \| `null`; \} \| `null`; `existing_budget_ids?`: `string`[] \| `null`; `id`: `string`; `name`: `string`; `updated_at`: `string`; \}\>

***

### list()

> **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)\<\{ `items`: `object`[]; `next_cursor?`: `string` \| `null`; \}\>

Defined in: [src/budgets/client.gen.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L37)

List Budget Programs

Lists Budget Programs belonging to this account

`GET /v1/budget_programs` — requires OAuth scope: `budgets.readonly`, `budgets`
Await for a single page, or `for await` to iterate items across all pages.

#### Parameters

##### query?

###### cursor?

`string` \| `null`

###### limit?

`number` \| `null`

##### options?

[`RequestOptions`](/brex/api/index/interfaces/requestoptions/)

#### Returns

[`PagePromise`](/brex/api/index/classes/pagepromise/)\<\{ `items`: `object`[]; `next_cursor?`: `string` \| `null`; \}\>