# List Relay Recordings

GET https://YOUR_SPACE.signalwire.com/api/relay/rest/recordings

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).

Reference: https://signalwire.com/docs/apis/relay-rest/recordings/list-recordings

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /recordings:
    get:
      operationId: list-recordings
      summary: List Relay 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
      parameters:
        - name: Authorization
          in: header
          description: >-
            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)

            ```
          required: true
          schema:
            type: string
      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://YOUR_SPACE.signalwire.com/api/relay/rest
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_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_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_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
    Recording:
      oneOf:
        - $ref: '#/components/schemas/PstnRecording'
        - $ref: '#/components/schemas/SipRecording'
        - $ref: '#/components/schemas/WebRtcRecording'
      description: >-
        Recording model. A recording is associated with exactly one call leg
        type (PSTN, SIP, or WebRTC).
      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
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        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)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/relay/rest/recordings"

headers = {"Authorization": "Basic <project_id>:<api_token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/recordings';
const options = {method: 'GET', headers: {Authorization: 'Basic <project_id>:<api_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/relay/rest/recordings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/relay/rest/recordings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://your_space.signalwire.com/api/relay/rest/recordings")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your_space.signalwire.com/api/relay/rest/recordings', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/recordings");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Basic <project_id>:<api_token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/relay/rest/recordings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```