Read one DM campaign
curl --request GET \
--url https://api.superx.so/v1/dm/campaigns/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.superx.so/v1/dm/campaigns/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.superx.so/v1/dm/campaigns/{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.superx.so/v1/dm/campaigns/{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 => [
"Authorization: Bearer <token>"
],
]);
$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.superx.so/v1/dm/campaigns/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.superx.so/v1/dm/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superx.so/v1/dm/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "V1StGXR8_Z5jdHi6B-myT",
"counts": {
"pending": 2,
"sending": 0,
"sent": 0,
"failed": 0,
"skipped": 0
},
"items": [
{
"id": "aZ7q2kR0pLmX",
"campaign_id": "V1StGXR8_Z5jdHi6B-myT",
"recipient": {
"x_user_id": "44196397",
"handle": "levelsio",
"name": "Pieter Levels",
"avatar_url": null
},
"message": "Hey Pieter, loved your thread on shipping fast.",
"template": "Hey [first], loved your thread on shipping fast.",
"status": "pending",
"error": null,
"created_at": "2026-09-11T09:00:00.000Z",
"scheduled_at": null,
"sent_at": null
}
]
}
}{
"error": {
"code": "invalid_api_key",
"message": "Unknown or revoked API key"
}
}{
"error": "subscription_required: The SuperX API requires an active subscription"
}{
"error": {
"code": "campaign_not_found",
"message": "No DM campaign with that id belongs to this account."
}
}{
"error": {
"code": "internal_error",
"message": "Failed to fetch posts"
}
}{
"error": {
"code": "upstream_error",
"message": "Failed to fetch scheduled posts. Try again shortly."
}
}{
"error": {
"code": "upstream_unavailable",
"message": "The scheduling service is temporarily unavailable. Retry with the same Idempotency-Key."
}
}DMs
Read one DM campaign
The messages this campaign queued, with a count per status.
pending has not gone out yet and can still be cancelled;
sending is in flight and cannot be stopped.
The rows ARE the campaign, so a campaign whose messages have all been
cancelled returns 404 campaign_not_found.
GET
/
v1
/
dm
/
campaigns
/
{id}
Read one DM campaign
curl --request GET \
--url https://api.superx.so/v1/dm/campaigns/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.superx.so/v1/dm/campaigns/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.superx.so/v1/dm/campaigns/{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.superx.so/v1/dm/campaigns/{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 => [
"Authorization: Bearer <token>"
],
]);
$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.superx.so/v1/dm/campaigns/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.superx.so/v1/dm/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superx.so/v1/dm/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "V1StGXR8_Z5jdHi6B-myT",
"counts": {
"pending": 2,
"sending": 0,
"sent": 0,
"failed": 0,
"skipped": 0
},
"items": [
{
"id": "aZ7q2kR0pLmX",
"campaign_id": "V1StGXR8_Z5jdHi6B-myT",
"recipient": {
"x_user_id": "44196397",
"handle": "levelsio",
"name": "Pieter Levels",
"avatar_url": null
},
"message": "Hey Pieter, loved your thread on shipping fast.",
"template": "Hey [first], loved your thread on shipping fast.",
"status": "pending",
"error": null,
"created_at": "2026-09-11T09:00:00.000Z",
"scheduled_at": null,
"sent_at": null
}
]
}
}{
"error": {
"code": "invalid_api_key",
"message": "Unknown or revoked API key"
}
}{
"error": "subscription_required: The SuperX API requires an active subscription"
}{
"error": {
"code": "campaign_not_found",
"message": "No DM campaign with that id belongs to this account."
}
}{
"error": {
"code": "internal_error",
"message": "Failed to fetch posts"
}
}{
"error": {
"code": "upstream_error",
"message": "Failed to fetch scheduled posts. Try again shortly."
}
}{
"error": {
"code": "upstream_unavailable",
"message": "The scheduling service is temporarily unavailable. Retry with the same Idempotency-Key."
}
}Authorizations
A SuperX API key ("sxk_..."), created in the SuperX app under Account > API / MCP / CLI. Keys are server-side secrets.
Path Parameters
Query Parameters
Account to act on, from GET /v1/accounts. Defaults to your main account. An id outside your accounts returns 404 account_not_found.
Response
The campaign.
Show child attributes
Show child attributes