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

# list

> List recordings in the project.

List recordings in the project.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/relay/rest/recordings:
    get:
      operationId: list_call_recordings
      summary: List recordings
      description: >-
        Returns a list of your recordings.


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_recordings
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    PaginationLinks:
      type: object
      properties:
        self:
          type: string
          description: Link to the current page.
        first:
          type: string
          description: Link to the first page.
        next:
          type: string
          description: Link to the next page. Only present when there are more results.
        prev:
          type: string
          description: Link to the previous page. Only present when not on the first page.
      required:
        - self
        - first
      description: Pagination links for list responses.
      title: PaginationLinks
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    PstnRecording:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the recording.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the project.
        created_at:
          type: string
          format: date-time
          description: Date and time when the recording was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the recording was last updated.
        duration_in_seconds:
          type: integer
          description: Duration of the recording in seconds.
        error_code:
          type: string
          description: Error code if the recording failed.
        price:
          type: number
          format: double
          description: Price of the recording.
        price_unit:
          type: string
          description: Currency unit for the price.
        status:
          type: string
          description: Status of the recording.
        url:
          type: string
          description: URL of the recording file.
        stereo:
          type: boolean
          description: Indicates whether the recording is stereo.
        byte_size:
          type: integer
          description: Size of the recording file in bytes.
        track:
          type: string
          description: Audio track of the recording.
        relay_conference_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Relay conference the recording belongs to, if any.
        relay_pstn_leg_id:
          $ref: '#/components/schemas/uuid'
          description: ID of the PSTN leg associated with the recording.
      required:
        - id
        - project_id
        - created_at
        - updated_at
        - duration_in_seconds
        - price
        - price_unit
        - status
        - url
        - stereo
        - track
        - relay_pstn_leg_id
      description: Recording from a PSTN call leg.
      title: PstnRecording
    SipRecording:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the recording.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the project.
        created_at:
          type: string
          format: date-time
          description: Date and time when the recording was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the recording was last updated.
        duration_in_seconds:
          type: integer
          description: Duration of the recording in seconds.
        error_code:
          type: string
          description: Error code if the recording failed.
        price:
          type: number
          format: double
          description: Price of the recording.
        price_unit:
          type: string
          description: Currency unit for the price.
        status:
          type: string
          description: Status of the recording.
        url:
          type: string
          description: URL of the recording file.
        stereo:
          type: boolean
          description: Indicates whether the recording is stereo.
        byte_size:
          type: integer
          description: Size of the recording file in bytes.
        track:
          type: string
          description: Audio track of the recording.
        relay_conference_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Relay conference the recording belongs to, if any.
        relay_sip_leg_id:
          $ref: '#/components/schemas/uuid'
          description: ID of the SIP leg associated with the recording.
      required:
        - id
        - project_id
        - created_at
        - updated_at
        - duration_in_seconds
        - price
        - price_unit
        - status
        - url
        - stereo
        - track
        - relay_sip_leg_id
      description: Recording from a SIP call leg.
      title: SipRecording
    WebRtcRecording:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the recording.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the project.
        created_at:
          type: string
          format: date-time
          description: Date and time when the recording was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the recording was last updated.
        duration_in_seconds:
          type: integer
          description: Duration of the recording in seconds.
        error_code:
          type: string
          description: Error code if the recording failed.
        price:
          type: number
          format: double
          description: Price of the recording.
        price_unit:
          type: string
          description: Currency unit for the price.
        status:
          type: string
          description: Status of the recording.
        url:
          type: string
          description: URL of the recording file.
        stereo:
          type: boolean
          description: Indicates whether the recording is stereo.
        byte_size:
          type: integer
          description: Size of the recording file in bytes.
        track:
          type: string
          description: Audio track of the recording.
        relay_conference_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Relay conference the recording belongs to, if any.
        relay_webrtc_leg_id:
          $ref: '#/components/schemas/uuid'
          description: ID of the WebRTC leg associated with the recording.
      required:
        - id
        - project_id
        - created_at
        - updated_at
        - duration_in_seconds
        - price
        - price_unit
        - status
        - url
        - stereo
        - track
        - relay_webrtc_leg_id
      description: Recording from a WebRTC call leg.
      title: WebRtcRecording
    ConferenceRecording:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the recording.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the project.
        created_at:
          type: string
          format: date-time
          description: Date and time when the recording was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the recording was last updated.
        duration_in_seconds:
          type: integer
          description: Duration of the recording in seconds.
        error_code:
          type: string
          description: Error code if the recording failed.
        price:
          type: number
          format: double
          description: Price of the recording.
        price_unit:
          type: string
          description: Currency unit for the price.
        status:
          type: string
          description: Status of the recording.
        url:
          type: string
          description: URL of the recording file.
        stereo:
          type: boolean
          description: Indicates whether the recording is stereo.
        byte_size:
          type: integer
          description: Size of the recording file in bytes.
        track:
          type: string
          description: Audio track of the recording.
        relay_conference_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Relay conference the recording belongs to.
      required:
        - id
        - project_id
        - created_at
        - updated_at
        - duration_in_seconds
        - price
        - price_unit
        - status
        - url
        - stereo
        - track
        - relay_conference_id
      description: Recording from a Relay conference.
      title: ConferenceRecording
    Recording:
      oneOf:
        - $ref: '#/components/schemas/PstnRecording'
        - $ref: '#/components/schemas/SipRecording'
        - $ref: '#/components/schemas/WebRtcRecording'
        - $ref: '#/components/schemas/ConferenceRecording'
      description: >-
        Recording model. A recording is associated with exactly one source type
        (PSTN, SIP, WebRTC, or Relay conference).
      title: Recording
    RecordingListResponse:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/PaginationLinks'
          description: Pagination links.
        data:
          type: array
          items:
            $ref: '#/components/schemas/Recording'
          description: List of recordings.
      required:
        - links
        - data
      description: Response containing a list of recordings.
      title: RecordingListResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    Types.StatusCodes.SpaceApiErrorItem:
      type: object
      properties:
        detail:
          type: string
          description: A description of what caused the error.
        status:
          type: string
          description: The HTTP status code.
        title:
          type: string
          description: A short summary of the error type.
        code:
          type: string
          description: The error code.
      required:
        - detail
        - status
        - title
        - code
      description: Details about a specific validation error.
      title: Types.StatusCodes.SpaceApiErrorItem
    Types.StatusCodes.ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request failed validation. See errors for details.
      title: Types.StatusCodes.ValidationError
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "byte_size": 10,
      "created_at": "2024-01-15T09:30:00Z",
      "duration_in_seconds": 2,
      "error_code": "string",
      "id": "d369a402-7b43-4512-8735-9d5e1f387814",
      "price": 0.05,
      "price_unit": "USD",
      "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
      "relay_conference_id": "0089cc48-4f98-4a6b-90d8-61f8a5d1b0e3",
      "relay_pstn_leg_id": "string",
      "status": "completed",
      "stereo": false,
      "track": "inbound",
      "updated_at": "2024-01-15T09:30:00Z",
      "url": "https://example.com/recording.mp3"
    }
  ]
}
```

## **Example**

```python {9}
from signalwire.rest import RestClient

client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)

result = client.recordings.list(page_size=20)
for rec in result.get("data", []):
    print(rec.get("id"), rec.get("duration"), rec.get("state"))
```