API Reference
Postman collections ↗Bud Console ↗

Retrieve Savings Goals

get
https://api-sandbox.thisisbud.com/goals/v1/savings

Retrieve all savings goals. The results from this endpoint can be filtered by the account_id query parameter. The response from this endpoint includes the saved_amount field which is the sum of the goal actions associated with the goal.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Use this parameter to filter the results on data associated with the given account id.

Example: RxsYshVGded4JeilkXgWKdXA

string

The day for which results are to be retrieved in the format RFC 3339.

Examples:

  • 2023-01-17T17:29:51Z
  • 2023-01-17T17:29:51-08:00
Headers
string
required

The API Client Identifier (Service Application Identifier).

uuid
required

A unique identifier for a Customer, as registered on Bud's platform.

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

string

The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.

Responses

Updated 7 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 months ago