Skip to content
/
List forward rules

List forward rules

Request

By default this endpoint lists all rules defined on the account. You can scope the list of rules by domain by providing the 'domain.name' query parameter.

Security
basicAuth
Query
pagestringrequired

Encoded paging information, provided via 'next', 'previous' links

limitintegerrequired

Limits the number of items returned in a request

domain.namestring

The name of the domain the rule is scoped to

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/forwards?page=string&limit=0&domain.name=string'

Responses

A 200 response

Bodyapplication/json
itemsArray of objects(github.com-mailgun-pathfinder-httpapi-ForwardsRule)required
pagingobject(github.com-mailgun-scaffold-httpapi-paging-PagingResponse)required
Response
{
  "items": [
    { … }
  ],
  "paging": {
    "previous": "https://api.mailgun.net/page=0",
    "first": "https://api.mailgun.net/page=0",
    "next": "https://api.mailgun.net/page=1",
    "last": "https://api.mailgun.net/page=22"
  }
}