List operations

GET

/operations

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

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

Returns a paginated list of operations. Use filters to narrow results by type 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[type]

The type of async operation.

string

Allowed values: provision_sender connect_domain deprovision_sender deprovision_domain

Return only operations of this type.

filter[status]

The current status of an operation.

string

Allowed values: pending in_progress completed failed cancelled

Return only operations with this status.

filter[sender_id]

string format: uuid

Return only operations for this sender.

Responses

200

A paginated list of operations.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

Unique identifier for the operation.

string format: uuid

type

required

The type of async operation.

string

Allowed values: provision_sender connect_domain deprovision_sender deprovision_domain

status

required

The current status of an operation.

string

Allowed values: pending in_progress completed failed cancelled

sender_id

The sender associated with this operation, if applicable.

string | null format: uuid

domain_id

The domain associated with this operation, if applicable.

string | null format: uuid

steps

Ordered list of steps within the operation.

Array<object>

object

name

required

Machine-readable step identifier.

string

status

required

The current status of this step.

string

Allowed values: pending in_progress completed failed skipped

started_at

When this step started. null if not yet started.

string | null format: date-time

completed_at

When this step completed. null if not yet completed.

string | null format: date-time

message

A human-readable explanation of the step’s current state.

string | null

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": "op_f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "type": "provision_sender",
      "status": "pending",
      "sender_id": "snd_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "domain_id": "dom_d4e5f6a7-b8c9-0123-def4-567890123456",
      "steps": [
        {
          "name": "detect_propagation",
          "status": "pending",
          "message": "Waiting for DNS propagation. Last check: 2026-03-24T10:15:00Z."
        }
      ],
      "created_at": "2026-03-24T10:00:00Z",
      "updated_at": "2026-03-24T10:15: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.