# Get paginated list of soundshots

`GET /api/plugins/soundshots`

Retrieves a paginated list of soundshots with optional filtering and sorting capabilities.

Authentication: no security requirement declared for this operation.

Parameters:

- `select` (query, object, optional)
  Type: object
  
  Schema: [Object](https://sourcey-gauzy.pages.dev/api-reference/models/object/index.md)

- `relations` (query, object, optional)
  Type: object
  
  Schema: [Object](https://sourcey-gauzy.pages.dev/api-reference/models/object/index.md)

- `order` (query, object, optional)
  Type: object
  
  Schema: [Object](https://sourcey-gauzy.pages.dev/api-reference/models/object/index.md)

- `withDeleted` (query, boolean, optional)
  Type: boolean

- `take` (query, number, optional)
  Type: number
  
  minimum: 0
  
  maximum: 100

- `skip` (query, number, optional)
  Type: number
  
  minimum: 0

- `startDate` (query, string, date-time, optional) - The start date for filtering soundshot records.
  Type: string, date-time; nullable

- `endDate` (query, string, date-time, optional) - The end date for filtering soundshot records.
  Type: string, date-time; nullable

- `tenantId` (query, string, optional) - The ID of the tenant.
  Type: string

- `organizationId` (query, string, optional) - The ID of the organization within the tenant.
  Type: string

- `employeeIds` (query, array, optional) - List of employee IDs to filter soundshots by.
  Type: array
  
  Items:
    Type: string

- `timeZone` (query, string, optional) - The timezone for date filtering, e.g., "UTC", "America/New_York".
  Type: string

- `params` (query, object, optional) - Pagination and filtering parameters for soundshots. Supports filtering by tenant, organization, and other soundshot properties.
  Type: object
  
  - `select` (optional)
    Type: object
  
  - `relations` (optional)
    Type: object
  
  - `where` (required)
    Type: object
  
  - `order` (optional)
    Type: object
  
  - `withDeleted` (optional)
    Type: boolean
  
  - `take` (optional)
    Type: number
    
    minimum: 0
    
    maximum: 100
  
  - `skip` (optional)
    Type: number
    
    minimum: 0

Responses:

- 200: Soundshots successfully fetched.

- 401: User is not authorized to access soundshots.

- 403: User does not have permission to list soundshots.

## Examples

### cURL

```bash
curl -X GET 'http://localhost:3000/api/plugins/soundshots'
```

### JavaScript

```javascript
const response = await fetch('http://localhost:3000/api/plugins/soundshots', {
  method: 'GET',
});

const data = await response.text();
```

### Python

```python
import requests

response = requests.get('http://localhost:3000/api/plugins/soundshots')
print(response.text)
```