Skip to main content
Use this endpoint to inspect the private delivery pools assigned to your workspace. A sender pool groups one or more sender accounts together to distribute outbound volume across them. You can use pool data to monitor daily capacity and decide whether to throttle or accelerate campaign send rates before queuing new work.
GET /v1/sender-pools

Authorization

All requests must include a Bearer token in the Authorization header. You can find your API key in the Leadterra dashboard under Settings → API Keys.

Request Parameters

This endpoint accepts no query parameters, path parameters, or request body.

Example Request

curl --request GET \
  --url https://app.leadterra.co/v1/sender-pools \
  --header "Authorization: Bearer sk_live_YOUR_KEY" \
  --header "Content-Type: application/json"

Response Fields

The response is a JSON array. Each element represents one sender pool belonging to your workspace.
id
string
Unique identifier for the pool (e.g., pool_01HABC).
name
string
Human-readable label assigned to the pool in the Leadterra dashboard.
dailyCapacity
integer
Maximum number of emails this pool can send within a 24-hour rolling window.
remainingVolume
integer
Number of emails still available to send within the current 24-hour window. Resets at the start of each period.
senderAccountIds
array of strings
List of sender account IDs that belong to this pool. Use the Sender Accounts endpoint to look up details for each ID.

Example Response

[
  {
    "id": "pool_01HABC123",
    "name": "Primary Outbound Pool",
    "dailyCapacity": 2000,
    "remainingVolume": 1340,
    "senderAccountIds": [
      "sa_01HXYZ001",
      "sa_01HXYZ002"
    ]
  }
]

Error Codes

HTTP StatusCodeMeaning
400 Bad Requestinvalid_requestThe request was malformed or contained unexpected parameters.
401 Unauthorizedauthentication_failedThe Authorization header is missing, malformed, or the key is invalid.
404 Not Foundworkspace_not_foundNo workspace is associated with the provided API key.