List email campaigns for the authenticated user · Email

infoOverview

About this API

Retrieves a paginated list of campaigns for the authenticated user. Supports search and sorting.

MethodGET

Versionv1.0

Get Test URL Get Test API Key

Content TypeNo request body

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader

Field nameAuthorization: Bearer <TOKEN>

Example valueYOUR_ACCESS_TOKEN

tuneParameters

Query Parameters

Append these values to the URL query string. Omit optional parameters when they are not needed.

pageintegerNot specifiedPage number (starts at 1).

limitintegerNot specifiedNumber of items per page (max 100).

searchstringNot specifiedSearch term applied to campaign name, subject line, or from email.

sortBystringNot specifiedField to sort by. Defaults to created_at.

sortOrderstringNot specifiedSort order (asc or desc). Defaults to desc.

uploadInput

Request Details

check_circle

No Request Body

Provide identifiers in the path and any supported values in the query string.

codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

Request URL

shield_lockCredentials protectedAdd secrets only in your secure server environment.

downloadSDK

curl --request GET 'https://email.1spoc.com/api/user/campaigns' \
  --header 'Authorization: Bearer <TOKEN>'

const response = await fetch('https://email.1spoc.com/api/user/campaigns', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer <TOKEN>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

const response = await fetch('https://email.1spoc.com/api/user/campaigns', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer <TOKEN>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

import json
import requests

url = 'https://email.1spoc.com/api/user/campaigns'
headers = {
  "Authorization": "Bearer <TOKEN>"
}
response = requests.get(url, headers=headers)

response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://email.1spoc.com/api/user/campaigns"))
    .header("Authorization", "Bearer <TOKEN>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://email.1spoc.com/api/user/campaigns',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => ["Authorization: Bearer <TOKEN>"],
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer <TOKEN>");
var response = await client.GetAsync("https://email.1spoc.com/api/user/campaigns");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    request, err := http.NewRequest("GET", "https://email.1spoc.com/api/user/campaigns", nil)
    if err != nil { panic(err) }
    request.Header.Set("Accept", "application/json")
    request.Header.Set("Authorization", "Bearer <TOKEN>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}

downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Campaign"
      }
    },
    "page": {
      "type": "integer",
      "description": "Current page number."
    },
    "limit": {
      "type": "integer",
      "description": "Number of items per page."
    },
    "total": {
      "type": "integer",
      "description": "Total number of campaigns matching the filters."
    },
    "totalPages": {
      "type": "integer",
      "description": "Total number of pages."
    }
  }
}

ruleHTTP Responses

Status Codes

200Successfully retrieved list of campaigns.

401Unauthorized (missing or invalid user access token)

500Internal server error