{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/accounts/:account_id/fax","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"created_at\": \"desc\"\n    },\n    \"total\": 2,\n    \"offset\": 0,\n    \"limit\": 25,\n    \"items\": [\n        {\n            \"id\": \"6a2d53d2ba5efaeecbb5e74039dd7e88eccd1393\",\n            \"extension\": {\n                \"id\": 1778029,\n                \"name\": \"default extension\",\n                \"extension\": 500,\n                \"voip_id\": 1330103,\n            },\n            \"from\": {\n                \"number\": \"+19085323133\",\n                \"name\": \"Test\",\n                \"city\": null,\n                \"state\": null\n            },\n            \"to\": \"+17327076616\",\n            \"is_new\": true,\n            \"pages\": 7,\n            \"created_at\": 1507867719,\n            \"form_data\": {\n                \"from_company\": \"\",\n                \"cover_date\": \"October 12, 2017\",\n                \"subject\": \"Test Outbound Fax\",\n                \"fax_cover\": \"on\",\n                \"memo\": \"\",\n                \"cover_time\": \"09:08 PM\",\n                \"to_name\": \"Wai Prod Account\",\n                \"to_company\": \"\",\n                \"from_name\": \"API QA Account\",\n                \"from_phone\": \"(908) 532-3133\"\n            }\n        }\n        {\n            \"id\": \"549a6c6747384ab0d1939f91a1a836e7d9b4c28f\",\n            \"extension\": {\n                \"id\": 1778029,\n                \"name\": \"default extension\",\n                \"extension\": 500,\n                \"voip_id\": 1330103,\n            },\n            \"from\": {\n                \"number\": \"+12014840200\",\n                \"name\": null,\n                \"city\": \"Jersey City\",\n                \"state\": \"NJ\"\n            },\n            \"to\": \"+19085323133\",\n            \"is_new\": false,\n            \"pages\": 2,\n            \"created_at\": 1507860316,\n        }\n    ]\n}\n","name":""}]},"settings":"","examples":{"codes":[{"code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/accounts/1330103/fax\",\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 30,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => \"GET\",\n    CURLOPT_POSTFIELDS => \"\",\n    CURLOPT_HTTPHEADER => array(\n        \"authorization: Bearer ThisIsYourAPIAccessToken\",\n        \"cache-control: no-cache\"\n    ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}","language":"php"}]},"method":"get","params":[{"name":"account_id","type":"int","default":"","desc":"Account ID","required":false,"in":"path","ref":"","_id":"56fae76b4787442b008db3c0"},{"name":"filters[id]","type":"array_string","default":"","desc":"ID filter","required":false,"in":"query","ref":"","_id":"573a3fdb17422532001d3451"},{"name":"filters[from]","type":"string","default":"","desc":"Caller ID filter, the E.164 phone number from which Fax was sent. Note: you must encode the + as %2B","required":false,"in":"query","ref":"","_id":"58054bd716161c0f0077e0b3"},{"name":"filters[to]","type":"string","default":"","desc":"Callee ID filter, the E.164 phone number to which Fax was sent. Note you must encode the + as %2B","required":false,"in":"query","ref":"","_id":"588b3ab1ed9aa81b00afbdac"},{"name":"filters[is_new]","type":"boolean","default":"","desc":"List only un-read Fax","required":false,"in":"query","ref":"","_id":"573a3fdb17422532001d3450"},{"name":"filters[created_at]","type":"int","default":"","desc":"Date string representing the UTC time that sms was created","required":false,"in":"query","ref":"","_id":"588b3bd5b39ea10f0047a984"},{"name":"filters[extension]","type":"string","default":"","desc":"Extension id where Fax is stored","required":false,"in":"query","ref":"","_id":"588b3bd5b39ea10f0047a985"},{"name":"sort[id]","type":"string","default":"","desc":"Sort by ID","required":false,"in":"query","ref":"","_id":"573a3fdb17422532001d344f"},{"name":"sort[created_at]","type":"string","default":"","desc":"Sort by the UTC time that Fax was created","required":false,"in":"query","ref":"","_id":"573a3fdb17422532001d344e"},{"name":"limit","type":"int","default":"","desc":"Max results","required":false,"in":"query","ref":"","_id":"573a43b07f35072900c8512d"},{"name":"offset","type":"int","default":"","desc":"Results to skip","required":false,"in":"query","ref":"","_id":"573a43b07f35072900c8512c"},{"name":"fields","type":"string","default":"all","desc":"Field set","required":false,"in":"query","ref":"","_id":"573c6c74ee2b3b2200422b70"}]},"next":{"description":"","pages":[]},"title":"List Fax","type":"endpoint","slug":"list-account-fax","excerpt":"Get a list of Fax for an account.  See [Intro to Fax](doc:account-fax) for more info on the properties.\n\nNote: This API is for users with Account Owner scope access token.  Users with Extension User scope token should invoke the List Fax API with the following definition:\n\nGET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/fax","body":"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59e032d13b756800107b4359","project":"55c8cff571d7580d0063a5e5","version":{"version":"4","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f","5ede526e75bc22005d0adecc"],"_id":"57624356653c2d2200fec79c","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","__v":23,"project":"55c8cff571d7580d0063a5e5"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Account Fax","slug":"fax","order":16,"from_sync":false,"reference":false,"_id":"59e0323d93da1f001c9ec170","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","createdAt":"2017-10-13T03:25:49.733Z","__v":0},"user":"56f99ab84d2b4f3400edb636","createdAt":"2017-10-13T03:28:17.324Z","githubsync":"","__v":6,"parentDoc":null}

getList Fax

Get a list of Fax for an account. See [Intro to Fax](doc:account-fax) for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the List Fax API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/fax

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID

Query Params

filters[id]:
array of strings
ID filter
filters[from]:
string
Caller ID filter, the E.164 phone number from which Fax was sent. Note: you must encode the + as %2B
filters[to]:
string
Callee ID filter, the E.164 phone number to which Fax was sent. Note you must encode the + as %2B
filters[is_new]:
boolean
List only un-read Fax
filters[created_at]:
integer
Date string representing the UTC time that sms was created
filters[extension]:
string
Extension id where Fax is stored
sort[id]:
string
Sort by ID
sort[created_at]:
string
Sort by the UTC time that Fax was created
limit:
integer
Max results
offset:
integer
Results to skip
fields:
stringall
Field set

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}