List goals - MX Documentation

List goals

curl --request GET \
  --url https://int-data.moneydesktop.com/goals \
  --header 'MD-SESSION-TOKEN: <api-key>'

import requests

url = "https://int-data.moneydesktop.com/goals"

headers = {"MD-SESSION-TOKEN": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'MD-SESSION-TOKEN': '<api-key>'}};

fetch('https://int-data.moneydesktop.com/goals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-data.moneydesktop.com/goals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-data.moneydesktop.com/goals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-data.moneydesktop.com/goals")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/goals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "goals": [
    {
      "account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
      "amount": 4500,
      "current_amount": 1651.27,
      "guid": "GOL-524ca5db-a2d5-44f3-b048-16de16059024",
      "goal_type_name": "string",
      "meta_type_name": "VACATION",
      "name": "Save for Europe.",
      "completed_at": "2015-06-19T10:37:04-06:00",
      "has_been_spent": false,
      "is_complete": false,
      "metadata": "Additional information",
      "position": 3,
      "projected_to_complete_at": "2022-06-14T16:03:53.000Z",
      "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "track_type_name": "SAVINGS_TRACK"
    }
  ]
}

GET

goals

List goals

curl --request GET \
  --url https://int-data.moneydesktop.com/goals \
  --header 'MD-SESSION-TOKEN: <api-key>'

import requests

url = "https://int-data.moneydesktop.com/goals"

headers = {"MD-SESSION-TOKEN": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'MD-SESSION-TOKEN': '<api-key>'}};

fetch('https://int-data.moneydesktop.com/goals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-data.moneydesktop.com/goals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-data.moneydesktop.com/goals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-data.moneydesktop.com/goals")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/goals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "goals": [
    {
      "account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
      "amount": 4500,
      "current_amount": 1651.27,
      "guid": "GOL-524ca5db-a2d5-44f3-b048-16de16059024",
      "goal_type_name": "string",
      "meta_type_name": "VACATION",
      "name": "Save for Europe.",
      "completed_at": "2015-06-19T10:37:04-06:00",
      "has_been_spent": false,
      "is_complete": false,
      "metadata": "Additional information",
      "position": 3,
      "projected_to_complete_at": "2022-06-14T16:03:53.000Z",
      "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "track_type_name": "SAVINGS_TRACK"
    }
  ]
}

List all goals a user can set.

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Response

200 - application/vnd.mx.nexus.v1+json

goals

object[]

Hide child attributes

goals.account_guid

string

Unique identifier for the goal. Defined by MX.

Example:

"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf"

goals.amount

number

The amount of the goal.

Example:

4500

goals.current_amount

number

The current amount of the goal.

Example:

1651.27

goals.guid

string

Unique identifier for the goal. Defined by MX.

Example:

"GOL-524ca5db-a2d5-44f3-b048-16de16059024"

goals.goal_type_name

string

The type of goal. Can be SAVE_AMOUNT or PAYOFF.

Example:

"string"

goals.meta_type_name

string

The category of the goal; see Goal Meta Type for more information.

Example:

"VACATION"

goals.name

string

The name of the goal that is visible to the user (i.e., "Europe Trip", "Savings", "Toyota Tacoma", etc).

Example:

"Save for Europe."

goals.completed_at

string

Date and time the goal was completed, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).

Example:

"2015-06-19T10:37:04-06:00"

goals.has_been_spent

boolean

If the goal has been spent, this field will be true. Otherwise, this field will be false.

Example:

false

goals.is_complete

boolean

If the goal is complete, this field will be true. Otherwise, this field will be false.

Example:

false

goals.metadata

string

Additional information a partner can store on the goal.

Example:

"Additional information"

goals.position

integer

The priority of the goal in relation to multiple goals.

Example:

3

goals.projected_to_complete_at

string

Date and time the goal is projected to be completed, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).

Example:

"2022-06-14T16:03:53.000Z"

goals.user_guid

string

Unique identifier for the user the goal is attached to. Defined by MX.

Example:

"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"

goals.track_type_name

string

The track of the goal. Can be DEBT_TRACK, SAVINGS_TRACK, RETIREMENT_TRACK, or EMERGENCY_FUND_TRACK.

Example:

"SAVINGS_TRACK"

Create a goal

Delete a goal