Skip to main content
GET
/
users
/
{user_guid}
/
spending_plans
/
{spending_plan_guid}
/
iterations
/
{iteration_number}
Read a spending plan iteration
curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number} \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://int-api.mx.com/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

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

print(response.text)
const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}', 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-api.mx.com/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$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-api.mx.com/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}"

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

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	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-api.mx.com/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}")

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

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "created_at": "2025-02-13T18:08:00+00:00",
  "end_on": "2023-05-31",
  "guid": "SPI-848e6648-3fa3-4632-ac8f-e65f03167102",
  "iteration_number": 1,
  "spending_plan_guid": "SPL-dbfe201d-c341-4bff-93c0-62a918d0b600",
  "start_on": "2023-05-01",
  "updated_at": "2025-02-13T18:09:00+00:00",
  "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
}

Authorizations

​
Authorization
string
header
required

The MX Platform API requires basic access authentication using your client_id and api_key. These credentials must be Base64 encoded and included in the Authorization header of each API request to ensure secure access.

Here's an example using curl to access v20250224. Replace https://int-api.mx.com/endpoint with the actual API endpoint you wish to access and your Base64 encoded client_id and api_key.

curl -L -X POST `https://int-api.mx.com/endpoint' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Version: v20250224'
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

​
Accept-Version
string
default:v20250224
required

MX Platform API version.

Example:

"v20250224"

Path Parameters

​
user_guid
string
required

The unique identifier for a user, beginning with the prefix USR-.

​
spending_plan_guid
string
required

The unique ID for the spending_plan.

​
iteration_number
integer
required

The current iteration number for the spending plan iteration.

Query Parameters

​
page
integer

Results are paginated. Specify current page.

​
records_per_page
integer

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

Response

200 - application/json

OK

​
created_at
string | null

The date and time the spending plan iteration was created, represented in ISO 8601 format with a timestamp.

Example:

"2025-02-13T18:08:00+00:00"

​
end_on
string | null

The date on which the spending plan iteration ends.

Example:

"2023-05-31"

​
guid
string | null

The unique identifier for the spending plan iteration. Defined by MX.

Example:

"SPI-848e6648-3fa3-4632-ac8f-e65f03167102"

​
iteration_number
integer | null

The current iteration number for the spending plan iteration.

Example:

1

​
spending_plan_guid
string | null

The unique identifier for the spending plan. Defined by MX.

Example:

"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600"

​
start_on
string | null

The date on which the spending plan iteration starts.

Example:

"2023-05-01"

​
updated_at
string | null

The date and time the resource was last updated in ISO 8601 format with a timestamp.

For categories, this field will always be null when is_default is true.

Example:

"2025-02-13T18:09:00+00:00"

​
user_guid
string | null

The unique identifier for the user. Defined by MX.

Example:

"USR-fa7537f3-48aa-a683-a02a-b18940482f54"