Get Campaigns

GET 
https://api.tinyemail.com/v1/campaign

Get all campaigns created in past

Request

Query Parameters

page integer

Page number (default is 0)

size integer

Number of items per page (default is 20)

sort string
Sort by field (default is created,ASC)
Example: completed,DESC
from date
Filter by created at date
Example: 2024-05-01T00:00:00
to date
Filter by created at date
Example: 2024-09-01T00:00:00
scheduled-from date
Filter by scheduled date
Example: 2024-05-01T00:00:00
scheduled-to date
Filter by scheduled date
Example: 2024-09-01T00:00:00

Responses

200

successful operation

application/json

Schema

Schema

campaigns object
content object[]
List of entities for the current page
Array [
id uuid
status string
contentSourceUrl string
campaign objectrequired
name stringrequired
subject stringrequired
previewText string
senderId uuidrequired
template objectrequired
html stringrequired
contactIds string[]
schedule object
dateTime string
days string[]
time string
delivered int64
requests int64
sent int64
open int64
totalOpen int64
clicked int64
totalClicked int64
unsubscribed int64
bounced int64
openProgress int64
totalOpenProgress double
totalClickedProgress double
unsubscribedProgress double
deliveredProgress double
bouncedProgress double
clickedProgress double
]
totalPages integer
last boolean
totalElements boolean
sort object
sorted boolean
unsorted boolean
empty boolean
first boolean
numberOfElements integer
size integer
number integer
empty boolean

Example (from schema)

{
  "campaigns": {
    "content": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "SCHEDULED",
        "contentSourceUrl": "https://app.tinyemail.com/api/v1/content.json",
        "campaign": {
          "name": "Black Friday Campaign",
          "subject": "Black Friday Offer",
          "previewText": "Offer!"
        },
        "senderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "template": {
          "html": ""
        },
        "contactIds": [
          [
            "2b4ea4a6-1fa3-4863-87e7-f498376d68",
            "b85a7177-b94b-43de-a8cd-03713c91b"
          ]
        ],
        "schedule": {
          "dateTime": "2024-01-26T08:15:00.00Z",
          "days": [
            [
              "MONDAY",
              "TUESDAY",
              "WEDNESDAY",
              "THURSDAY",
              "FRIDAY",
              "SATURDAY",
              "SUNDAY"
            ]
          ],
          "time": "03:00:00"
        },
        "delivered": 1,
        "requests": 1,
        "sent": 1,
        "open": 1,
        "totalOpen": 1,
        "clicked": 1,
        "totalClicked": 1,
        "unsubscribed": 1,
        "bounced": 1,
        "openProgress": 1,
        "totalOpenProgress": 1,
        "totalClickedProgress": 1,
        "unsubscribedProgress": 1,
        "deliveredProgress": 1,
        "bouncedProgress": 1,
        "clickedProgress": 1
      }
    ],
    "totalPages": 50,
    "last": false,
    "totalElements": 20,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "first": true,
    "numberOfElements": 10000,
    "size": 20,
    "number": 0,
    "empty": false
  }
}

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Some error message"
}

401

API key is missing or invalid

405

Method Not Allowed

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyin: headerdescription: To obtain API-KEY, please contact our customer support by email support@tinyemail.com or directly by chat.

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api.tinyemail.com/v1/campaign' \
-H 'Accept: application/json' \
-H 'X-API-KEY: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.tinyemail.com/v1

Auth

api_key

Parameters

page — query

size — query

sort — query

from — query

to — query

scheduled-from — query

scheduled-to — query

ResponseClear

Click the Send API Request button above and see the response here!