***

title: Faxes
slug: /reference/typescript/rest/compat/faxes
description: Manage faxes with CRUD operations and media sub-resources.
max-toc-depth: 3
---------------------

For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

[messages]: /docs/server-sdks/reference/typescript/rest/compat/messages

[restclient]: /docs/server-sdks/reference/typescript/rest/client

[list]: /docs/server-sdks/reference/typescript/rest/compat/faxes/list

[create]: /docs/server-sdks/reference/typescript/rest/compat/faxes/create

[get]: /docs/server-sdks/reference/typescript/rest/compat/faxes/get

[update]: /docs/server-sdks/reference/typescript/rest/compat/faxes/update

[delete]: /docs/server-sdks/reference/typescript/rest/compat/faxes/delete

[listmedia]: /docs/server-sdks/reference/typescript/rest/compat/faxes/list-media

[getmedia]: /docs/server-sdks/reference/typescript/rest/compat/faxes/get-media

[deletemedia]: /docs/server-sdks/reference/typescript/rest/compat/faxes/delete-media

Manage faxes with CRUD operations and media sub-resources. The media sub-resource
pattern is identical to [`messages`][messages].

Access via `client.compat.faxes` on a [`RestClient`][restclient] instance.

```typescript {8}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});

const faxes = await client.compat.faxes.list();
```

## **Methods**

### Fax CRUD

<CardGroup cols={3}>
  <Card title="list" href="/docs/server-sdks/reference/typescript/rest/compat/faxes/list">
    List faxes in the account.
  </Card>

  <Card title="create" href="/docs/server-sdks/reference/typescript/rest/compat/faxes/create">
    Send a new fax.
  </Card>

  <Card title="get" href="/docs/server-sdks/reference/typescript/rest/compat/faxes/get">
    Retrieve a single fax by SID.
  </Card>

  <Card title="update" href="/docs/server-sdks/reference/typescript/rest/compat/faxes/update">
    Update a fax resource.
  </Card>

  <Card title="delete" href="/docs/server-sdks/reference/typescript/rest/compat/faxes/delete">
    Delete a fax record.
  </Card>
</CardGroup>

### Media

<CardGroup cols={3}>
  <Card title="listMedia" href="/docs/server-sdks/reference/typescript/rest/compat/faxes/list-media">
    List media items attached to a fax.
  </Card>

  <Card title="getMedia" href="/docs/server-sdks/reference/typescript/rest/compat/faxes/get-media">
    Retrieve a specific media item from a fax.
  </Card>

  <Card title="deleteMedia" href="/docs/server-sdks/reference/typescript/rest/compat/faxes/delete-media">
    Delete a media item from a fax.
  </Card>
</CardGroup>