Skip to content

Retrieve complaints

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

Retrieving complaints

To retrieve complaints from inboxroad please make a GET request to https://webapi.inboxroad.com/api/v1/fbl with the correct bearer-token and content type as application/json

Terminal window
curl -H ‘Authorization: Basic {{ TOKEN }}’
curl -H ‘Content-Type:application/json’ https://webapi.inboxroad.com/api/v1/fbl

*You should have received your API token during your set-up at inboxroad. If not, please contact your account manager.

Fields in JSON response

Response should be in JSON format and have such fields:

Field nameDescription
uuidUnique identifier
timeloggedUnix timestamp
header_list_unsubscribeList unsubscribe header
origOriginator (from MAIL FROM:)
rcptRecipient (RCPT TO:) being reported
header_subjectHeader subject line
header_return_pathOriginal ReturnPath
header_fromOriginal Header from

Query parameters for complaints calls

The following query parameters can be used for complaints calls:

Param namePossible valuesDescription
last_idUUID of the last recordReturns all logs after the given record
orderasc, descDetermines whether records are returned in ascending or descending order

For example:

Terminal window
curl -H ‘Authorization: Basic {{ TOKEN }}’
curl -H ‘Content-Type:application/json’ https://webapi.inboxroad.com/api/v1/fbl?last_id=ce95fca7-b028-4f5c-810c-8bddeda4cac6&order=asc

Pagination

All records are paginated with the following structure

Field nameDescription
countTotal number of results
nextURL to the next page of records
previousURL to the previous page of records
resultslist of results