> ## Documentation Index > Fetch the complete documentation index at: https://ahasend.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List Suppressions > Returns a list of suppressions for the account **Query Parameters:** - `domain`: Filter by domain (optional) - `email`: Filter by email (optional) - `from_time`: Filter suppressions created after this time (RFC3339 format, optional) - `to_time`: Filter suppressions created before this time (RFC3339 format, optional) - `limit`: Maximum number of items to return (1-100, default: 100) - `cursor`: Pagination cursor for the next page ## OpenAPI ````yaml /openapi.yaml GET /v2/accounts/{account_id}/suppressions openapi: 3.1.0 info: title: AhaSend API v2 description: > The AhaSend API v2 allows you to send transactional emails, manage domains, webhooks, routes, API keys, and view statistics. ## Authentication All API requests must be authenticated using a Bearer token in the Authorization header: ``` Authorization: Bearer aha-sk-64-CHARACTER-RANDOM-STRING ``` ## Scopes API keys have specific scopes that control access to different resources and actions: ### Message Scopes - `messages:send:all` - Send messages from any domain in the account - `messages:send:{domain}` - Send messages from a specific domain - `messages:cancel:all` - Cancel messages from any domain - `messages:cancel:{domain}` - Cancel messages from a specific domain - `messages:read:all` - Read messages from any domain - `messages:read:{domain}` - Read messages from a specific domain ### Domain Scopes - `domains:read` - Read all domains - `domains:write` - Create and update domains - `domains:delete:all` - Delete any domain - `domains:delete:{domain}` - Delete a specific domain ### Account Scopes - `accounts:read` - Read account information - `accounts:write` - Update account settings - `accounts:billing` - Access billing information - `accounts:members:read` - Read account members - `accounts:members:add` - Add account members - `accounts:members:update` - Update account members - `accounts:members:remove` - Remove account members ### Webhook Scopes - `webhooks:read:all` - Read all webhooks - `webhooks:read:{domain}` - Read webhooks for a specific domain - `webhooks:write:all` - Create and update webhooks - `webhooks:write:{domain}` - Create and update webhooks for a specific domain - `webhooks:delete:all` - Delete any webhook - `webhooks:delete:{domain}` - Delete webhooks for a specific domain ### Route Scopes - `routes:read:all` - Read all routes - `routes:read:{domain}` - Read routes for a specific domain - `routes:write:all` - Create and update routes - `routes:write:{domain}` - Create and update routes for a specific domain - `routes:delete:all` - Delete any route - `routes:delete:{domain}` - Delete routes for a specific domain ### Suppression Scopes - `suppressions:read` - Read suppressions - `suppressions:write` - Create suppressions - `suppressions:delete` - Delete suppressions - `suppressions:wipe` - Delete all suppressions (dangerous) ### SMTP Credentials Scopes - `smtp-credentials:read:all` - Read all SMTP credentials - `smtp-credentials:read:{domain}` - Read SMTP credentials for a specific domain - `smtp-credentials:write:all` - Create SMTP credentials - `smtp-credentials:write:{domain}` - Create SMTP credentials for a specific domain - `smtp-credentials:delete:all` - Delete any SMTP credentials - `smtp-credentials:delete:{domain}` - Delete SMTP credentials for a specific domain ### Statistics Scopes - `statistics-transactional:read:all` - Read all transactional statistics - `statistics-transactional:read:{domain}` - Read transactional statistics for a specific domain ### API Key Scopes - `api-keys:read` - Read API keys - `api-keys:write` - Create and update API keys - `api-keys:delete` - Delete API keys ## Rate Limiting - General API endpoints: 100 requests per second, 200 burst - Statistics endpoints: 1 request per second, 1 burst ## Pagination List endpoints use cursor-based pagination with the following parameters: - `limit`: Maximum number of items to return (default: 100, max: 100) - `cursor`: Pagination cursor for the next page ## Time Formats All timestamps must be in RFC3339 format, e.g., `2023-12-25T10:30:00Z` ## Idempotency POST requests support idempotency through the optional `Idempotency-Key` header. When provided: - The same request can be safely retried multiple times - Duplicate requests return the same response with `Idempotent-Replayed: true` - In-progress requests return HTTP 409 with `Idempotent-Replayed: false` - Failed requests return HTTP 412 with `Idempotent-Replayed: false` - Reusing a key with a different request payload returns HTTP 422 - Idempotency keys expire after 24 hours version: 2.0.0 contact: email: support@ahasend.com license: name: MIT identifier: MIT servers: - url: https://api.ahasend.com description: Production server security: - BearerAuth: [] tags: - name: Utility description: Utility endpoints for health checks and diagnostics - name: API Keys description: Manage API keys for authentication and access control - name: Domains description: Manage sending domains - name: Messages description: Send and manage transactional messages - name: Accounts description: Manage account settings and members - name: Suppressions description: Manage email suppressions - name: Routes description: Manage inbound email routing - name: Webhooks description: Manage webhook notifications - name: SMTP Credentials description: Manage SMTP authentication credentials - name: Statistics description: Access transactional email statistics - name: Message Events description: Webhooks for outbound message delivery events - name: Suppression Events description: Webhooks for suppression list changes - name: Domain Events description: Webhooks for domain configuration issues - name: Route Events description: Webhooks for inbound email routing paths: /v2/accounts/{account_id}/suppressions: get: tags: - Suppressions summary: Get Suppressions description: > Returns a list of suppressions for the account **Query Parameters:** - `domain`: Filter by domain (optional) - `email`: Filter by email (optional) - `from_time`: Filter suppressions created after this time (RFC3339 format, optional) - `to_time`: Filter suppressions created before this time (RFC3339 format, optional) - `limit`: Maximum number of items to return (1-100, default: 100) - `cursor`: Pagination cursor for the next page operationId: getSuppressions parameters: - name: account_id in: path required: true description: Account ID schema: type: string format: uuid - name: domain in: query description: Filter by domain schema: type: string - name: email in: query description: Email address schema: type: string format: email - name: from_time in: query description: Filter suppressions created after this time (RFC3339 format) schema: type: string format: date-time - name: to_time in: query description: Filter suppressions created before this time (RFC3339 format) schema: type: string format: date-time - name: limit in: query description: Maximum number of items to return (1-100) schema: type: integer minimum: 1 maximum: 100 default: 100 - name: after in: query description: >- Pagination cursor for the next page. Provide the value provided in `next_cursor` from the response. schema: type: string - name: before in: query description: >- Pagination cursor for the previous page. Provide the value provided in `previous_cursor` from the response. schema: type: string responses: '200': description: List of suppressions content: application/json: schema: $ref: '#/components/schemas/PaginatedSuppressionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Domain not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: - suppressions:read x-code-samples: - lang: go label: AhaSend Go SDK source: | package main import ( "context" "fmt" "log" "github.com/AhaSend/ahasend-go/api" "github.com/AhaSend/ahasend-go/models/requests" "github.com/google/uuid" ) func main() { // Create API client with authentication client := api.NewAPIClient( api.WithAPIKey("aha-sk-your-64-character-key"), ) accountID := uuid.New() // Create context for the API call ctx := context.Background() // Call the ping endpoint response, httpResp, err := client.SuppressionsAPI.GetSuppressions( ctx, accountID, requests.GetSuppressionsParams{}, nil, ) if err != nil { log.Fatalf("Error getting suppressions: %v", err) } // Check response if httpResp.StatusCode == 200 { fmt.Printf("✅ Status: %d\n", httpResp.StatusCode) if response != nil { fmt.Printf("Found %d suppressions\n", len(response.Data)) } } else { fmt.Printf("❌ Unexpected status code: %d\n", httpResp.StatusCode) } } components: schemas: PaginatedSuppressionsResponse: type: object required: - object - data - pagination properties: object: type: string enum: - list description: Object type identifier data: type: array items: $ref: '#/components/schemas/Suppression' description: Array of suppressions pagination: $ref: '#/components/schemas/PaginationInfo' ErrorResponse: type: object required: - message properties: message: type: string description: Error description example: message: Error message Suppression: type: object properties: object: type: string enum: - suppression description: Object type identifier id: type: string format: uuid description: Unique identifier for the suppression created_at: type: string format: date-time description: When the suppression was created email: type: string format: email description: Suppressed email address domain: type: string nullable: true description: Domain for which the email is suppressed reason: type: string nullable: true description: Reason for suppression expires_at: type: string format: date-time description: When the suppression expires required: - object - id - created_at - email - expires_at PaginationInfo: type: object required: - has_more properties: has_more: type: boolean description: Whether there are more items available next_cursor: type: string description: Cursor for the next page of results previous_cursor: type: string description: Cursor for the previous page of results example: has_more: true next_cursor: eyJpZCI6MTIzNH0= securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: aha-sk-64-CHARACTER-RANDOM-STRING description: API key for authentication ````