List promotion purchases

GET

/api/v3/promotions/purchases

const url = 'https://api.tryletterhead.com/api/v3/promotions/purchases?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/promotions/purchases?api=true' \
  --header 'Authorization: Bearer <token>'

List every purchase ever made against your company’s promotion listings — a purchase stays listed for its whole lifecycle (not just while pending review), so check each item’s status to see what’s still actionable.

v3 endpoints expect a company API key.

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

When set to true, the endpoint accepts authorization with your API Key.

Responses

200

200 OK

application/json

object

items

Array<object>

object

uniqueId

string

type

string

buyerEmail

string

amount

number

currency

string

status

string

isApproved

boolean

createdAt

string

updatedAt

string

listingTitle

string

listingChannels

Array<string>

dateRangeStart

string

dateRangeEnd

string

message

string

total

integer

Example

{
  "items": [
    {
      "uniqueId": "d4e5f6a7b8",
      "type": "listing",
      "buyerEmail": "[email protected]",
      "amount": 250,
      "currency": "usd",
      "status": "pending",
      "isApproved": false,
      "createdAt": "2026-06-04 17:30:00",
      "updatedAt": "2026-06-04 17:30:00",
      "listingTitle": "Front newsletter banner",
      "listingChannels": [
        "news-daily"
      ],
      "dateRangeStart": "2026-07-01",
      "dateRangeEnd": "2026-07-08"
    }
  ],
  "message": "Promotion purchases retrieved successfully",
  "total": 1
}

Still can’t find what you need? Contact support.