Sending domains

List what sends from a domain

GET/v1/sending-domains/{id}/usage

Requires an API key with the domains:read scope. About keys and scopes

Campaigns not yet sent (draft, scheduled or sending) and journeys with an email step whose sender is on this domain, up to 50 of each, most recently edited first. Transactional sends name their sender per request, so they are not listed.

Path parameters

idstringrequired: uuid

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

campaignsobjectrequired

2 child attributes

itemsobject[]required

3 child attributes

idstringrequired: uuid
namestringrequired
statusstringrequired

hasMorebooleanrequired

journeysobjectrequired

2 child attributes

itemsobject[]required

3 child attributes

idstringrequired: uuid
namestringrequired
statusstringrequired

hasMorebooleanrequired

curl https://api.kirora.io/v1/sending-domains/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/usage \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/sending-domains/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/usage', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/sending-domains/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/usage",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

import (
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/sending-domains/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/usage", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "campaigns": {
      "items": [
        {
          "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
          "name": "Weekend specials",
          "status": "status_example"
        }
      ],
      "hasMore": true
    },
    "journeys": {
      "items": [
        {
          "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
          "name": "Weekend specials",
          "status": "status_example"
        }
      ],
      "hasMore": true
    }
  }
}

Example values are generated from the schema.