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

Retrieve Fax Media

|View as Markdown|Open in Claude|
GET
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:AccountSid/Faxes/:FaxSid/Media/:Sid
GET
/api/laml/2010-04-01/Accounts/:AccountSid/Faxes/:FaxSid/Media/:Sid
$curl https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media/Sid \
>     -u "<project_id>:<api_token>"
1{
2  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
3  "content_type": "application/pdf",
4  "date_created": "2018-11-26T20:00:00Z",
5  "date_updated": "2018-11-27T20:00:00Z",
6  "fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
7  "sid": "b3877c40-da60-4998-90ad-b792e98472me",
8  "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
9  "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
10}

Retrieve 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

Delete 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.
SidstringRequiredformat: "uuid"
The Fax ID that uniquely identifies the Fax.

Response

The request has succeeded.
account_sidstring
The unique identifier for the account.
content_typestring
The content type of the media.
date_createdstring
The date, in ISO 8601 format, this media was created.
date_updatedstring
The date, in ISO 8601 format, this media was updated.
fax_sidstring
The unique identifier for the fax.
sidstring
The unique identifier for the media.
uristring
The URI for the media.
urlstring
The URL for the media.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found 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)