Bounce Emails API

Table of Contents
Bounce Email Attributes
Get a List of Bounce Emails
Get a Single Bounce Email

Bounce Email Attributes

id string	The `id` of the bounce email
username string	The name of the user of the bounce email
domain string	The domain
email string	The email

Get a List of Bounce Emails

Get a list of the basic details of all bounce emails available to user’s organization.

URL

GET /ga/api/v2/bounce_emails

Request Parameters

The following parameters may be included as part of the query string:

domain string	Get a list of bounce emails with this exact, case-insensitive `domain`.
domain_contains string	Get a list of bounce emails whose `domain` contains this case-insensitive string.
username string	Get a list of bounce emails with this exact case-insensitive `username`.
username_contains string	Get a list of bounce emails whose `username` contains this case-insensitive string.
order_by string	Specify a bounce email field to sort the results by. Can be `email` or `id`. `email` will be ordered case-insensitively. Defaults to `id`.

Response

The response will be a JSON array where each element contains the Bounce Email Attributes.

This endpoint returns paginated records with a default page size of 2000.

Example

GET /ga/api/v2/bounce_emails

HTTP/1.1 200 OK

{
  "success": true,
  "data": [
    {
      "domain": "example491.com",
      "email": "[email protected]",
      "id": "1@1",
      "username": "bounces"
    }
  ],
  "error_code": null,
  "error_message": null,
  "page": 0,
  "per_page": 2000,
  "num_records": 1,
  "num_pages": 1
}

Get a Single Bounce Email

Get all the basic details of a single bounce email.

URL

GET /ga/api/v2/bounce_emails/:id

Request Parameters

This API method does not require any additional parameters.

Response

The response will be a JSON object containing the Bounce Email Attributes.

Example

Note that the JSON response will not be “pretty formatted” as it is below.

GET /ga/api/v2/bounce_emails/1@1

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "domain": "example491.com",
    "email": "[email protected]",
    "id": "1@1",
    "username": "bounces"
  },
  "error_code": null,
  "error_message": null
}