Get a campaign

Retrieve a single campaign by ID.

GET /v1/campaigns/{campaignId}

Get a campaign

cURL

curl --request GET \
  --url https://app.loops.so/api/v1/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.loops.so/api/v1/campaigns/{campaignId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.loops.so/api/v1/campaigns/{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://app.loops.so/api/v1/campaigns/{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: 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://app.loops.so/api/v1/campaigns/{campaignId}"

	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://app.loops.so/api/v1/campaigns/{campaignId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.loops.so/api/v1/campaigns/{campaignId}")

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

200

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "emailMessageId": "<string>",
  "campaignGroupId": "<string>",
  "mailingListId": "<string>",
  "audienceSegmentId": "<string>",
  "audienceFilter": {
    "conditions": [
      {
        "type": "property",
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "scheduling": {
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId · string · required

The ID of the campaign.

Response

200

application/json

Successful.

id · string · required

The ID of the campaign.

name · string · required

The name of the campaign.

status · enum<string> · required

The status of the campaign.

Available options: Draft, Scheduled, Sending, Sent

createdAt · string<date-time> · required

ISO 8601 timestamp for when the campaign was created.

updatedAt · string<date-time> · required

ISO 8601 timestamp for when the campaign was last updated.

emailMessageId · string | null · required

The associated email message ID.

campaignGroupId · string | null · required

The ID of the campaign group this campaign belongs to..

mailingListId · string | null · required

The ID of the mailing list this campaign sends to, if set.

audienceSegmentId · string | null · required

The ID of the audience segment this campaign targets, if set.

audienceFilter · object | null · required

The filter rules that define the audience for this campaign, if set.

Show child attributes

scheduling · object · required

When the campaign is scheduled to send.

Show child attributes