List all complaints

Request

Paginate a list of complaints for the domain.

Security

basicAuth

Path

domain_namestringrequired

Domain to retrieve complaints from

Query

limitinteger

Maximum number of records to return (optional, default: 100, max: 1000)

pagestring

Page direction relative to the above address, can be next, previous or last, if empty, returns the first page

addressstringrequired

address serving as a "divider" between pages

termstringrequired

Filter records based on addresses that start with the specified substring.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/{domain_name}/complaints?limit=0&page=string&address=string&term=string'

Responses

A 200 response

Bodyapplication/json

itemsArray of objects(github.com-mailgun-blackbook-model-Complaint)required

pagingobject(github.com-mailgun-scaffold-httpapi-paging-PagingResponse)required

Response

{
  "items": [
    { … }
  ],
  "paging": {
    "previous": "<previous page url>",
    "first": "<first page url>",
    "next": "<next page url>",
    "last": "<last page url>"
  }
}