List senders

GET

/senders

curl --request GET \
  --url 'https://live-api.customers.ac/v1/senders?page%5Bsize%5D=25&filter%5Bstatus%5D=pending' \
  --header 'Authorization: Bearer <token>'

• Production
• Sandbox — no real infrastructure is provisioned; operations complete instantly.

Returns a paginated list of senders. You can filter by user or status.

Authorizations

• BearerAuth
  senders:read

Parameters

Query Parameters

page[size]

integer

default: 25 >= 1 <= 100

Maximum number of records to return. Default: 25, maximum: 100.

page[after]

string

Opaque cursor returned by a previous list response. Pass this to fetch the next page.

filter[user_id]

string format: uuid

Return only senders belonging to this user.

filter[status]

The current lifecycle status of a sender.

string

Allowed values: pending provisioning active deprovisioning deprovisioned

Return only senders with this status.

Responses

200

A paginated list of senders.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

Unique identifier for the sender.

string format: uuid

user_id

required

The user this sender belongs to.

string format: uuid

name

required

A human-readable name for this sender, chosen by the partner.

string

status

required

The current lifecycle status of a sender.

string

Allowed values: pending provisioning active deprovisioning deprovisioned

personas

Templates used to generate mailbox usernames on each domain.

Array<object>

A persona template. One mailbox is created per persona per domain (e.g., 3 personas x 3 domains = 9 mailboxes).

object

first_name

required

First name used in the mailbox address.

string

last_name

required

Last name used in the mailbox address.

string

title

Job title, used for display name in the mailbox.

string | null

domains_count

Number of domains connected to this sender.

integer

mailboxes_count

Total number of mailboxes across all domains.

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

pagination

required

Cursor-based pagination metadata.

object

has_more

required

true if there are more records after this page.

boolean

next_cursor

Pass this value as page[after] to fetch the next page. null when there are no more records.

string | null

Example

{
  "data": [
    {
      "id": "snd_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "user_id": "usr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Acme Outbound Q1",
      "status": "pending",
      "personas": [
        {
          "first_name": "Jane",
          "last_name": "Doe",
          "title": "Head of Partnerships"
        }
      ],
      "domains_count": 3,
      "mailboxes_count": 9,
      "created_at": "2026-03-20T09:00:00Z",
      "updated_at": "2026-03-20T12:30:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6InVzcl96OXk4eDd3NiJ9"
  }
}

401

Authentication failed. The API key is missing or invalid.

Media typeapplication/json

object

error

required

object

code

required

A machine-readable error code.

string

Allowed values: auth.missing_key auth.invalid_key auth.insufficient_scope rate.quota_exceeded validation.required_field validation.invalid_value resource.not_found resource.already_exists resource.not_ready server.error

message

required

A human-readable explanation of the error.

string

doc_url

A link to the documentation page for this error code.

string format: uri

details

For validation errors, a list of individual field-level problems.

Array<object> | null

object

field

required

The field that caused the error, in dot notation.

string

code

A machine-readable code for this specific validation issue.

string

message

required

A human-readable explanation.

string

Examples

No API key provided

{
  "error": {
    "code": "auth.missing_key",
    "message": "No API key was provided. Include your key in the Authorization header: Bearer sac_live_xxxxx.",
    "doc_url": "https://docs.sending.ac/errors/auth-missing-key"
  }
}

Invalid API key

{
  "error": {
    "code": "auth.invalid_key",
    "message": "The API key provided is invalid or has been revoked.",
    "doc_url": "https://docs.sending.ac/errors/auth-invalid-key"
  }
}

403

The API key does not have the required scope for this operation.

Media typeapplication/json

object

error

required

object

code

required

A machine-readable error code.

string

Allowed values: auth.missing_key auth.invalid_key auth.insufficient_scope rate.quota_exceeded validation.required_field validation.invalid_value resource.not_found resource.already_exists resource.not_ready server.error

message

required

A human-readable explanation of the error.

string

doc_url

A link to the documentation page for this error code.

string format: uri

details

For validation errors, a list of individual field-level problems.

Array<object> | null

object

field

required

The field that caused the error, in dot notation.

string

code

A machine-readable code for this specific validation issue.

string

message

required

A human-readable explanation.

string

Example

{
  "error": {
    "code": "auth.insufficient_scope",
    "message": "Your API key does not have the 'senders:write' scope required for this operation.",
    "doc_url": "https://docs.sending.ac/errors/auth-insufficient-scope"
  }
}

429

You have exceeded the rate limit. Wait and retry.

Media typeapplication/json

object

error

required

object

code

required

A machine-readable error code.

string

Allowed values: auth.missing_key auth.invalid_key auth.insufficient_scope rate.quota_exceeded validation.required_field validation.invalid_value resource.not_found resource.already_exists resource.not_ready server.error

message

required

A human-readable explanation of the error.

string

doc_url

A link to the documentation page for this error code.

string format: uri

details

For validation errors, a list of individual field-level problems.

Array<object> | null

object

field

required

The field that caused the error, in dot notation.

string

code

A machine-readable code for this specific validation issue.

string

message

required

A human-readable explanation.

string

Example

{
  "error": {
    "code": "rate.quota_exceeded",
    "message": "Rate limit exceeded. You may make 120 requests per minute. Retry after 30 seconds.",
    "doc_url": "https://docs.sending.ac/errors/rate-quota-exceeded"
  }
}

Headers

Retry-After

integer

Example

30

Number of seconds to wait before retrying.

X-RateLimit-Limit

integer

Example

120

The maximum number of requests allowed per minute.

X-RateLimit-Remaining

integer

Example

0

The number of requests remaining in the current window.

X-RateLimit-Reset

integer

Example

1711267260

Unix timestamp when the rate limit window resets.