For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
      • GETList Fax Media
      • GETRetrieve Fax Media
      • DELDelete Fax Media
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIFax Media

List Fax Media

|View as Markdown|Open in Claude|
GET
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:AccountSid/Faxes/:FaxSid/Media
GET
/api/laml/2010-04-01/Accounts/:AccountSid/Faxes/:FaxSid/Media
$curl https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media \
>     -u "<project_id>:<api_token>"
1{
2  "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?Page=0&PageSize=50",
3  "first_page_uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?PageSize=50",
4  "next_page_uri": null,
5  "previous_page_uri": null,
6  "page": 0,
7  "page_size": 50,
8  "media": [
9    {
10      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
11      "content_type": "application/pdf",
12      "date_created": "2018-11-26T20:00:00Z",
13      "date_updated": "2018-11-27T20:00:00Z",
14      "fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
15      "sid": "b3877c40-da60-4998-90ad-b792e98472me",
16      "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
17      "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
18    }
19  ],
20  "fax_media": [
21    {
22      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
23      "content_type": "application/pdf",
24      "date_created": "2018-11-26T20:00:00Z",
25      "date_updated": "2018-11-27T20:00:00Z",
26      "fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
27      "sid": "b3877c40-da60-4998-90ad-b792e98472me",
28      "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
29      "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
30    }
31  ]
32}

List all media for a fax.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Fax.

Learn more about API scopes.

Was this page helpful?
Previous

Retrieve Fax Media

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.
FaxSidstringRequiredformat: "uuid"
The Fax ID that uniquely identifies the Fax.

Query parameters

PageintegerOptional>=0Defaults to 0

The page index to retrieve. Zero-indexed.

PageSizeintegerOptional1-1000Defaults to 50
The number of results per page. Default is 50, maximum is 1000.
PageTokenstringOptional

Token for cursor-based pagination. Required when Page > 0.

Response

The request has succeeded.
uristring
The URI of the current page.
first_page_uristring
The URI of the first page.
next_page_uristring or null
The URI of the next page, or null if there are no more pages.
previous_page_uristring or null
The URI of the previous page, or null if this is the first page.
pageinteger
The current page number.
page_sizeinteger
The number of items per page.
medialist of objects
List of media.
fax_medialist of objects

List of fax media (alias for media).

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)