***

title: Conferences
slug: /reference/typescript/rest/compat/conferences
description: Manage conferences with participants, recordings, and media streams.
max-toc-depth: 3
---------------------

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

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

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

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

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

[listparticipants]: /docs/server-sdks/reference/typescript/rest/compat/conferences/list-participants

[getparticipant]: /docs/server-sdks/reference/typescript/rest/compat/conferences/get-participant

[updateparticipant]: /docs/server-sdks/reference/typescript/rest/compat/conferences/update-participant

[removeparticipant]: /docs/server-sdks/reference/typescript/rest/compat/conferences/remove-participant

[listrecordings]: /docs/server-sdks/reference/typescript/rest/compat/conferences/list-recordings

[getrecording]: /docs/server-sdks/reference/typescript/rest/compat/conferences/get-recording

[updaterecording]: /docs/server-sdks/reference/typescript/rest/compat/conferences/update-recording

[deleterecording]: /docs/server-sdks/reference/typescript/rest/compat/conferences/delete-recording

[startstream]: /docs/server-sdks/reference/typescript/rest/compat/conferences/start-stream

[stopstream]: /docs/server-sdks/reference/typescript/rest/compat/conferences/stop-stream

Manage conferences with participants, recordings, and streams. Conferences are
list/get/update only (they are created implicitly when a participant dials in
via LAML).

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

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

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

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

## **Methods**

### Conference CRUD

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

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

  <Card title="update" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/update">
    Update a conference (e.g., end it or set an announce URL).
  </Card>
</CardGroup>

### Participants

<CardGroup cols={3}>
  <Card title="listParticipants" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/list-participants">
    List participants in a conference.
  </Card>

  <Card title="getParticipant" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/get-participant">
    Retrieve a specific participant in a conference.
  </Card>

  <Card title="updateParticipant" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/update-participant">
    Update a participant in a conference (mute or hold).
  </Card>

  <Card title="removeParticipant" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/remove-participant">
    Remove a participant from a conference.
  </Card>
</CardGroup>

### Recordings

<CardGroup cols={3}>
  <Card title="listRecordings" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/list-recordings">
    List recordings for a conference.
  </Card>

  <Card title="getRecording" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/get-recording">
    Retrieve a specific conference recording.
  </Card>

  <Card title="updateRecording" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/update-recording">
    Update a conference recording (pause, resume, or stop).
  </Card>

  <Card title="deleteRecording" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/delete-recording">
    Delete a conference recording.
  </Card>
</CardGroup>

### Streaming

<CardGroup cols={2}>
  <Card title="startStream" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/start-stream">
    Start a media stream on a conference.
  </Card>

  <Card title="stopStream" href="/docs/server-sdks/reference/typescript/rest/compat/conferences/stop-stream">
    Stop a media stream on a conference.
  </Card>
</CardGroup>