Retrieve complaints

If you have questions regarding this API, please visit our API FAQ page.

Complaints (feedback-loop reports) are received from ISPs when a recipient marks your email as spam. Monitoring them is important for protecting your sender reputation.

Retrieving complaints

Make a GET request to https://webapi.inboxroad.com/api/v1/fbl with a valid token (see v1 authentication).

curl -X GET 'https://webapi.inboxroad.com/api/v1/fbl' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json'

Response fields

Each complaint record contains the following fields:

Field name	Description
uuid	Unique identifier of the record.
timelogged	Unix timestamp of when the event was logged.
header_list_unsubscribe	List-Unsubscribe header.
orig	Originator (from MAIL FROM:).
rcpt	Recipient (RCPT TO:) being reported.
header_subject	Subject header of the original email.
header_return_path	Original Return-Path.
header_from	Original From header.
extra_fields	Any custom headers configured for your account.

Query parameters

Param name	Possible values	Description
last_id	UUID of the last record	Returns records strictly newer than this record’s timelogged. Use for incremental polling.
order	asc, desc	Sort order. desc (newest first) is the default.
page	Integer	1-based page number.
page_size	Integer	Items per page. Default 100, maximum 1000.

For example:

curl -X GET 'https://webapi.inboxroad.com/api/v1/fbl?last_id=ce95fca7-b028-4f5c-810c-8bddeda4cac6&order=asc' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json'

Pagination

Results are paginated with the standard structure:

Field name	Description
count	Total number of records.
next	URL to the next page, or null.
previous	URL to the previous page, or null.
results	List of complaint records.