---
title: "Recorder List"
method: GET
path: "/recorder"
tags: ["Recorder/Survey"]
---

# Recorder List

`GET /recorder`

## Request

- Base URL: `https://api.speakai.co/v1`
- URL: `https://api.speakai.co/v1/recorder`
- Auth: API key in header `x-speakai-key` and API key in header `x-access-token`

## API Endpoint: Retrieve Recorders

This endpoint retrieves a list of recorders with pagination and sorting options. It allows users to fetch details about available recorders based on specified parameters.

### Request

**Method:** GET
**URL:** `{{url}}/v1/recorder`

**Query Parameters:**

- `page` (integer): The page number of the results to retrieve. Default is `0`.

- `pageSize` (integer): The number of records to return per page. Default is `20`.

- `sortBy` (string): The field by which to sort the results, followed by the sorting order. For example, `createdAt:desc` sorts by the creation date in descending order.


### Response

The response will contain a JSON object with the following structure:

- `status` (string): The status of the request.

- `data` (object): Contains the results of the request.

 - `totalCount` (integer): The total number of recorders available.

 - `page` (integer): The current page number of the results.

 - `recorderList` (array): A list of recorder objects, each containing:

 - `duration` (integer): The duration of the recording.

 - `isAutoAnalyze` (boolean): Indicates if the recorder is set for automatic analysis.

 - `isActive` (boolean): Indicates if the recorder is currently active.

 - `recordings` (array): An array of recordings associated with the recorder.

 - `createdAt` (string): The timestamp when the recorder was created.

 - `updatedAt` (string): The timestamp when the recorder was last updated.

 - `userId` (string): The ID of the user associated with the recorder.

 - `recorderId` (string): The unique ID of the recorder.

 - `token` (string): A token associated with the recorder.

 - `name` (string): The name of the recorder.

 - `meta` (object): Metadata about the recorder, including:

 - `type` (object): Specifies the types of media supported (e.g., video and audio).

 - `client` (object): Information about the client, including name and email.


### Example Response

``` json
{
 "status": "",
 "data": {
 "totalCount": 0,
 "page": "",
 "recorderList": [
 {
 "duration": 0,
 "isAutoAnalyze": true,
 "isActive": true,
 "recordings": [],
 "createdAt": "",
 "updatedAt": "",
 "userId": "",
 "recorderId": "",
 "token": "",
 "name": "",
 "meta": {
 "type": {
 "video": true,
 "audio": true
 },
 "client": {
 "name": true,
 "email": true
 }
 }
 }
 ]
 }
}

 ```

## Query parameters

- `page` integer
- `pageSize` integer
- `filterName` string
- `sortBy` string

## Response `200`

OK

- object
  - `status` string
  - `data` object
    - `totalCount` integer
    - `page` string
    - `recorderList` object[]
      - `duration` integer
      - `isAutoAnalyze` boolean
      - `isActive` boolean
      - `recordings` unknown[]
        - unknown
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `userId` string
      - `recorderId` string
      - `token` string
      - `name` string
      - `meta` object
        - `type` object
          - `video` boolean
          - `audio` boolean
        - `client` object
          - `name` boolean
          - `email` boolean

---

[API](https://skmtc.dev/speakai/apis/speak-ai-api.md) · [All operations](https://skmtc.dev/speakai/apis/speak-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/speakai/apis/speak-ai-api/revisions/52d777e6d46e?raw)