Query Budget Orders
Returns a filtered, sorted, and paginated list of budget orders.
URL
POST https://api.ads.apple.com/v1/shared-budgets/queryHeader Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Optional | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | SharedBudgetQueryResponse | Successful operation. Returns SharedBudgetQueryResponse ( |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | Bad Request. Returns ErrorResponse. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | Unauthorized. |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Forbidden. |
| 404 | Not Found Content-Type: application/json | ErrorResponse | Resource not found. Returns ErrorResponse. |
| 429 | Too Many Requests Content-Type: application/json | ErrorResponse | Rate Limit Exceeded. See Applying Rate Limits. |
| 500 | Internal Server Error Content-Type: application/json | ErrorResponse | Internal Server Error. Returns ErrorResponse. |
Discussion
This endpoint finds budget orders by name, status, or date range, or retrieves them across an ad account. Narrow and order the result set with filters, sorting, and pagination.
See QueryFilterOperator for the full set of supported comparison operators.
Filterable Fields
Field | Type | Operators | Sortable | Description |
|---|---|---|---|---|
| boolean |
| Whether the budget order has been soft-deleted. | |
| integer |
| System-assigned unique identifier for the budget order. | |
| string |
| Yes | The budget order’s display name. |
| integer |
| The organization that owns the budget order. | |
| array of integers |
| The ad accounts the budget order is assigned to. | |
| string (enum) |
| The budget order’s current status. See Budgetsystemstatus. | |
| array of strings (enum) |
| Reasons contributing to the current | |
| string (date-time) |
| The budget order’s scheduled start date and time. | |
| string (date-time) |
| The budget order’s scheduled end date and time. | |
| string (date-time) |
| Timestamp when the budget order was created. | |
| string (date-time) |
| Timestamp of the last modification to the budget order. |
The value and invoiceDetail fields aren’t filterable. The request body is a QueryRequest composed of QueryFilter conditions and QuerySort directives (QuerySortOrder), controlled by QueryPagination.