List faxes
List faxes sent (OUTBOUND) or received (INBOUND), set parameters to filter the list. Example: Return calls made between 1st of January 2021 and 10th of January 2021.
created>=2021-01-01&startTime<=2021-01-10
Query parameters
Limits results to faxes that were sent using the specified service.
Filter calls based on createTime. If you make the query more precise, fewer results will be returned. For example, 2021-02-01 will return all calls from the first of February 2021, and 2021-02-01T14:00:00Z will return all calls after 14:00 on the first of February. This field also supports <= and >= to search for calls in a range ?createTime>=2021-10-01&startTime<=2021-10-30 to get a list of calls for all of October 2021. It is also possible to submit partial dates. For example, createTime=2021-02 will return all calls for February 2021.
If not value is submitted, the default value is the prior week.
The direction of the fax.
Limits results to faxes with the specified direction.
The status of the fax
Limits results to faxes with the specified status.
A phone number that you want to use to filter results. The parameter search with startsWith, so you can pass a partial number to get all faxes sent to numbers that start with the number you passed.
A phone number in E.164 format, including the leading '+'.
A phone number that you want to use to filter results. The parameter search with startsWith, so you can pass a partial number to get all faxes sent to numbers that start with the number you passed.
You can use this to attach labels to your call that you can use in your applications. It is a key value store.
- application/json format: "labels": {"label1":"value1"}
- multipart/form-data format: labels[label1] = value1
{
"use-case": "fraudPrevention",
"costCenter": "sales"
}If you include this parameter, you can export the list of faxes as a .csv file. Default value is csv
The maximum number of items to return per request. The default is 100 and the maximum is 1000. If you need to export larger amounts and pagination is not suitable for you can use the Export function in the dashboard.
The page you want to retrieve returned from a previous List request, if any
Response
Result of the query.
Example response
{
"faxes": [
{
"id": "01F3J0G1M4WQR6HGY6HCF6JA0K",
"direction": "OUTBOUND",
"from": "+15551235656",
"to": "+15551235656",
"contentUrl": [
"www.google.com",
"www.sinch.com"
],
"price": {
"currencyCode": "USD",
"amount": "0.0040"
},
"pagesSentSuccessfully": 3,
"labels": {
"use-case": "fraudPrevention",
"costCenter": "sales"
},
"callbackUrl": "https://www.my-website.com/callback",
"coverPageData": {
"toName": "Acme Corp"
},
"projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
"serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J"
}
]
}