Get Message Status

curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/message/{id} \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.sandbox.metriport.com/medical/v1/message/{id}', 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://api.sandbox.metriport.com/medical/v1/message/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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://api.sandbox.metriport.com/medical/v1/message/{id}"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.metriport.com/medical/v1/message/{id}")

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

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

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

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const message = await metriport.getMessage(
  "00000000-0000-0000-0000-000000000000"
);

GET

medical

message

{id}

Get Message Status

curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/message/{id} \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.sandbox.metriport.com/medical/v1/message/{id}', 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://api.sandbox.metriport.com/medical/v1/message/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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://api.sandbox.metriport.com/medical/v1/message/{id}"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.metriport.com/medical/v1/message/{id}")

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

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

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

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const message = await metriport.getMessage(
  "00000000-0000-0000-0000-000000000000"
);

This endpoint is currently under construction. Please reach out to support if you'd like to use it.

Returns the status of a specific message request - use this to check the progress of that message.

We recommend using the message.status webhook to receive delivery status updates instead of polling this endpoint.

Path Params

string

required

The ID of the message. This is returned when you send a message.

Response

Returns the Message at the top level (not wrapped).

string

required

The ID of the message.

string

required

The ID of the Patient the message relates to.

string

required

One of outbound or inbound.

string

required

The delivery status. One of processing, completed, or failed.

string

required

How the message is transported. One of xdr or direct.

string

The network used for XDR delivery. One of EHEX, CAREQUALITY, or COMMONWELL. Required when transportMethod is xdr.

string

required

Where the message is delivered. An OID or a Direct email address.

string

required

The subject of the message.

string

Plain-text content of the message, when present.

string[]

Document IDs attached to the message, when present.

string[]

Intended recipient NPIs, when present.

string

required

ISO 8601 timestamp of when the message was created / accepted for send.

string

required

ISO 8601 timestamp of the latest status update.

string

Failure reason. Only present when status is failed.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "patientId": "11111111-1111-1111-1111-111111111111",
  "direction": "outbound",
  "status": "completed",
  "transportMethod": "xdr",
  "network": "EHEX",
  "destination": "2.16.840.1.113883.3.666.123.4.101",
  "subject": "Referral - cardiology",
  "body": "Please review the attached referral for cardiology consultation.",
  "attachments": ["00000000-0000-0000-0000-000000000000"],
  "intendedRecipientNpi": ["1234567890"],
  "sentAt": "2026-06-16T18:40:00.000Z",
  "updatedAt": "2026-06-16T18:42:11.000Z"
}

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const message = await metriport.getMessage(
  "00000000-0000-0000-0000-000000000000"
);

Getting Started

API Reference

Handling Data

FHIR

API Tools

More Info

Legacy API Reference

Get Message Status

Path Params

Response

​Path Params

​Response

Path Params

Response