Get recipient list entries

GET 
/users/:email/lists/:listname

Get recipient list entries

Request

Path Parameters

email stringrequired

The email address of the recipient whose list will be fetched.

listname stringrequired

Possible values: [blocklist, safelist, blacklist, whitelist]

The name of the list to fetch. One of 'safelist' or 'blocklist'. 'whitelist' and 'blacklist' are deprecated

Responses

200

Successfully retrieved the entries

application/json

Schema

Schema

• Array [

item string

The value of this entry. The meaning of this value depends on the item_type.

item_type string

The item type.

action string

Which list this entry is on, e.g. safelist or blocklist.

• ]

Example (from schema)

[
  {
    "item": "string",
    "item_type": "string",
    "action": "string"
  }
]

403

Returned in the case that the domain in the user email is associated with an api key that is different than the one in the request, the user is associated with a different customer, or the domain in the user email is an alias domain.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

404

Account not found

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

500

Internal Server Error

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

Loading...