Read job - MX Documentation

Read job

curl --request GET \
  --url https://int-api.mx.com/users/{user_identifier}/jobs/{job_guid} \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_identifier}/jobs/{job_guid}"

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_identifier}/jobs/{job_guid}', 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_identifier}/jobs/{job_guid}",
  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_identifier}/jobs/{job_guid}"

	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_identifier}/jobs/{job_guid}")
  .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_identifier}/jobs/{job_guid}")

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

{
  "job": {
    "created_at": "2025-02-13T18:08:00+00:00",
    "error_message": null,
    "error_message_code": null,
    "finished_at": "2022-06-16T18:42:43+00:00",
    "institution_guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
    "is_authenticated": true,
    "member_guid": "MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa",
    "started_at": "2022-06-16T18:42:30+00:00",
    "status": 6,
    "status_name": "COMPLETED",
    "updated_at": "2022-06-16T18:42:43+00:00",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

GET

users

{user_identifier}

jobs

{job_guid}

Read job

curl --request GET \
  --url https://int-api.mx.com/users/{user_identifier}/jobs/{job_guid} \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_identifier}/jobs/{job_guid}"

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_identifier}/jobs/{job_guid}', 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_identifier}/jobs/{job_guid}",
  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_identifier}/jobs/{job_guid}"

	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_identifier}/jobs/{job_guid}")
  .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_identifier}/jobs/{job_guid}")

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

{
  "job": {
    "created_at": "2025-02-13T18:08:00+00:00",
    "error_message": null,
    "error_message_code": null,
    "finished_at": "2022-06-16T18:42:43+00:00",
    "institution_guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
    "is_authenticated": true,
    "member_guid": "MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa",
    "started_at": "2022-06-16T18:42:30+00:00",
    "status": 6,
    "status_name": "COMPLETED",
    "updated_at": "2022-06-16T18:42:43+00:00",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

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_identifier

string

required

Use either the user id you defined or the MX-defined user guid. See MX-Defined GUIDs vs IDs Defined by You.

job_guid

string

required

The unique identifier for the job. Defined by MX.

Response

200 - application/json

job

object

Hide child attributes

job.created_at

string

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

Example:

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

job.error_message

string | null

If the job returns an error, this field will contain the message of the error.

Example:

null

job.error_message_code

string | null

Date and time the job finished, represented in ISO 8601 format with timestamp.

Example:

null

job.finished_at

string

The date and time the job finished, represented in ISO 8601 format with a timestamp.

Example:

"2022-06-16T18:42:43+00:00"

job.institution_guid

string

Unique identifier for the institution the job is attached to. Defined by MX.

Example:

"INS-1572a04c-912b-59bf-5841-332c7dfafaef"

job.is_authenticated

boolean

If the member's credentials have been authenticated, this field will be true. Otherwise, this field will be false.

Example:

true

job.member_guid

string

Unique identifier for the member the job is attached to. Defined by MX.

Example:

"MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa"

job.started_at

string

Date and time the job started, represented in ISO 8601 format with timestamp.

Example:

"2022-06-16T18:42:30+00:00"

job.status

integer

The status of the job.

Example:

6

job.status_name

any

The name of the status.

Example:

"COMPLETED"

job.updated_at

string

Date and time the job was updated, represented in ISO 8601 format with timestamp.

Example:

"2022-06-16T18:42:43+00:00"

job.user_guid

string

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

Example:

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

Jobs Overview