curl --request GET \
--url https://api.spacebring.com/campaigns/v1 \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.spacebring.com/campaigns/v1"
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', 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",
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"
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")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spacebring.com/campaigns/v1")
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{
"campaigns": [
{
"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"
}
],
"nextPageToken": "<string>",
"searchQueryNext": "<string>"
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}Retrieve campaigns
Retrieve the campaigns of the network, newest first, or only those whose audience includes a location. A campaign belongs to the network and reaches the members of the locations in its audience. With bearer token authentication, the user must be an administrator, and the list leaves out campaigns in none of whose locations they can view campaigns.
OAuth
Required scopes:campaigns.readonly or campaignscurl --request GET \
--url https://api.spacebring.com/campaigns/v1 \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.spacebring.com/campaigns/v1"
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', 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",
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"
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")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spacebring.com/campaigns/v1")
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{
"campaigns": [
{
"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"
}
],
"nextPageToken": "<string>",
"searchQueryNext": "<string>"
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}Authorizations
See our authentication documentation for how to authorize your requests
Headers
The id of the network. Required when using bearer token authentication
Query Parameters
Filter by channel. Comma-separated, one or more of: email, push.
IDs of the campaigns to get, up to 25. The campaigns found are returned on one page, newest first. Comma-separated, one or more UUIDs.
Maximum number of campaigns per page. Defaults to 25.
1 <= x <= 100ID of a location whose campaigns to list: those whose audience includes it. Lists the campaigns of every location when omitted.
Token of the page to read next.
Filter by stage. Comma-separated, one or more of: draft, scheduled, sending, sent, canceled, failed.