Get Campaign

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

Get all details of a campaign

Request

Path Parameters

id uuidrequired

ID of the campaign

Responses

200

successful operation

application/json

Schema

Schema

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

Example (from schema)

{
  "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
}

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: header

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

• CURL

curl -L -X GET 'https://api.tinyemail.com/v1/campaign/:id' \
-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

id — pathrequired

ResponseClear

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