INinvoiceninja
reports

Contact reports

Changed on

Export contact reports

post/api/v1/reports/contacts

Request

Query parameters

per_pageinteger
Example:20

The number of records to return for each request, default is 20

pageinteger
Example:1

The page number to return for this request (when performing pagination), default is 1

Headers

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Request body

date_rangestring

The string representation of the date range of data to be returned

date_keystring

The date column to search between.

start_datestring

The start date to search between

end_datestring

The end date to search between

report_keysstring[]

Example request

{
  "date_range": "last7",
  "date_key": "created_at",
  "start_date": "2000-10-31",
  "end_date": "2",
  "report_keys": [
    "['name','date']"
  ]
}

Response

success

Changes

  • 69a36036d334Revision changes
    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status