Contents

Get a Budget Order by ID

Retrieves a single budget order by its ID.

URL

GET https://api.ads.apple.com/v1/shared-budgets/{id}

Path Parameters

NameTypeDescription
id Requiredstring

Header Parameters

NameTypeDescription
X-Ap-Context Optionalstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
SharedBudgetResponse

Successful operation. Returns SharedBudgetResponse (result: SharedBudget).

400Bad Request
Content-Type: application/json
ErrorResponse

Bad Request. Returns ErrorResponse.

401Unauthorized
Content-Type: application/json
ErrorResponse

Unauthorized.

403Forbidden
Content-Type: application/json
ErrorResponse

Forbidden.

404Not Found
Content-Type: application/json
ErrorResponse

Resource not found. Returns ErrorResponse.

429Too Many Requests
Content-Type: application/json
ErrorResponse

Rate Limit Exceeded. See Applying Rate Limits.

500Internal Server Error
Content-Type: application/json
ErrorResponse

Internal Server Error. Returns ErrorResponse.

Discussion

This endpoint retrieves the full details of a specific budget order by its ID. The response includes the budget order’s value, active date range, assigned ad accounts, and invoice details.

Payload Examples

See Also