Get Fax History

GET

/fax/history

Fax

Get a list of Fax History.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://rest.clicksend.com/v3/fax/history?date_from={date_from}&date_to={date_to}&q={q}&order_by={order_by}'

Response Example

{
    "data": {
        "current_page": 1,
        "data": [
            {
                "_api_username": "username",
                "_file_url": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/document.pdf",
                "carrier": "",
                "country": "AU",
                "custom_string": "custom_string",
                "date": null,
                "date_added": 1457572619,
                "from": "+61267132168",
                "from_email": null,
                "list_id": null,
                "message_id": "2FDA7622-FC6E-4D21-B335-32FF860D7E19",
                "message_pages": "6.00",
                "message_price": "13.2000",
                "schedule": "1436874701",
                "status": "Sent",
                "status_code": "201",
                "status_text": "Sent",
                "subaccount_id": 1,
                "to": "+61261111115",
                "user_id": 1
            },
            {
                "_api_username": "username",
                "_file_url": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/document.pdf",
                "carrier": "",
                "country": "AU",
                "custom_string": "custom_string",
                "date": null,
                "date_added": 1457586514,
                "from": "+61267132168",
                "from_email": null,
                "list_id": null,
                "message_id": "A6A20382-8211-46B9-8F09-E7337AE6626D",
                "message_pages": "6.00",
                "message_price": "13.2000",
                "schedule": "1436874701",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "to": "+61261111115",
                "user_id": 1
            }
        ],
        "from": 1,
        "last_page": 1,
        "next_page_url": null,
        "per_page": 15,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Here is your history."
}

Request

Path Params

date_from

number

required

Customize result by setting from date (timestsamp)

Example:

1457572619

date_to

number

required

Customize result by setting to date (timestamp)

Example:

1457573000

string

required

Custom query

Example:

status:Sent,status_code:201

order_by

string

required

Order result by

Example:

subject:desc

Query Params

date_from

string

required

Example:

{date_from}

date_to

string

required

Example:

{date_to}

string

required

Example:

{q}

order_by

string

required

Example:

{order_by}

Responses

🟢200OK

application/json

Body

object {0}

Export Fax History

Calculate Price