Skip to content

Retrieve complaints

If you have questions about the API, please visit our API FAQ page.

A complaint (feedback-loop report) occurs when a recipient marks your email as spam.

Monitoring complaints is important for protecting your sender reputation and maintaining healthy email deliverability.

Retrieve complaint events

Send a GET request to:

https://webapi.inboxroad.com/api/v1/fbl

Authentication is required. See Authentication.

Example request

Terminal window
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 nameDescription
uuidUnique identifier of the record.
timeloggedUnix timestamp of when the event was logged.
header_list_unsubscribeList-Unsubscribe header.
origOriginator (from MAIL FROM:).
rcptRecipient (RCPT TO:) being reported.
header_subjectSubject header of the original email.
header_return_pathOriginal Return-Path.
header_fromOriginal From header.
extra_fieldsAny custom headers configured for your account.

Query parameters

ParameterPossible valuesDescription
last_idUUID of the last recordReturns records strictly newer than this record’s timelogged. Useful for incremental polling.
orderasc, descSort order. Default is desc (newest first).
pageInteger1-based page number.
page_sizeIntegerNumber of items per page. Default is 100, maximum is 1000.

Example with query parameters

Terminal window
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

Responses use the following pagination structure:

Field nameDescription
countTotal number of records.
nextURL to the next page, or null.
previousURL to the previous page, or null.
resultsList of complaint records.