Get a campaign
curl --request GET \
--url https://api.spacebring.com/campaigns/v1/{campaignId} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.spacebring.com/campaigns/v1/{campaignId}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.spacebring.com/campaigns/v1/{campaignId}', 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.spacebring.com/campaigns/v1/{campaignId}",
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: 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://api.spacebring.com/campaigns/v1/{campaignId}"
req, _ := http.NewRequest("GET", url, nil)
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://api.spacebring.com/campaigns/v1/{campaignId}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spacebring.com/campaigns/v1/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"campaign": {
"audience": {
"locationRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rules": [
{
"companyRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"type": "companies"
}
]
},
"channel": "email",
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"stats": {
"bounced": 0,
"clicked": 0,
"complained": 0,
"delivered": 0,
"opened": 0,
"recipients": 0
},
"status": "draft",
"updateDate": "2023-11-07T05:31:56Z",
"charge": {
"amount": 0,
"currencyCode": "<string>"
},
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"email": {
"body": "<string>",
"subject": "<string>",
"buttonLabel": "<string>",
"buttonUrl": "<string>",
"replyTo": "<string>"
},
"push": {
"body": "<string>",
"title": "<string>",
"link": "<string>"
},
"scheduleDate": "2023-11-07T05:31:56Z",
"sendDate": "2023-11-07T05:31:56Z",
"sms": {
"body": "<string>"
}
}
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}Campaigns
Get a campaign
Get a campaign by its id, with its delivery statistics once sending starts. With bearer token authentication, the user must be an administrator who can view campaigns in one of the campaign’s locations.
OAuth
Required scopes:campaigns.readonly or campaignsGET
/
campaigns
/
v1
/
{campaignId}
Get a campaign
curl --request GET \
--url https://api.spacebring.com/campaigns/v1/{campaignId} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.spacebring.com/campaigns/v1/{campaignId}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.spacebring.com/campaigns/v1/{campaignId}', 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.spacebring.com/campaigns/v1/{campaignId}",
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: 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://api.spacebring.com/campaigns/v1/{campaignId}"
req, _ := http.NewRequest("GET", url, nil)
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://api.spacebring.com/campaigns/v1/{campaignId}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spacebring.com/campaigns/v1/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"campaign": {
"audience": {
"locationRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rules": [
{
"companyRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"type": "companies"
}
]
},
"channel": "email",
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"stats": {
"bounced": 0,
"clicked": 0,
"complained": 0,
"delivered": 0,
"opened": 0,
"recipients": 0
},
"status": "draft",
"updateDate": "2023-11-07T05:31:56Z",
"charge": {
"amount": 0,
"currencyCode": "<string>"
},
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"email": {
"body": "<string>",
"subject": "<string>",
"buttonLabel": "<string>",
"buttonUrl": "<string>",
"replyTo": "<string>"
},
"push": {
"body": "<string>",
"title": "<string>",
"link": "<string>"
},
"scheduleDate": "2023-11-07T05:31:56Z",
"sendDate": "2023-11-07T05:31:56Z",
"sms": {
"body": "<string>"
}
}
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}Authorizations
BasicAuthOAuth2
See our authentication documentation for how to authorize your requests