List Files

Get a list of files that the authenticated user has access to.

Endpoint

GET ${baseUrl}/files

Query Parameters

ParameterTypeDescription
statusstringFilter by file status. Valid values: pending, in-progress, delivered

Response

interface FileListResponse {
  success: boolean
  data: {
    files: {
      id: number
      fileId: string
      filename: string
      duration: number
      filesize: string
      status: FileStatus
      uploadedBy: {
        id: number
        email: string
        firstname: string
        lastname: string
      }
      createdAt: string
      customInstructions?: string
      downloadCount: number
    }[]
  }
}

Example Request

const response = await fetch('${baseUrl}/files?status=pending', {
  headers: {
    Authorization: 'Basic YOUR_API_KEY',
  },
})
 
const data = await response.json()

Error Codes

Status CodeDescription
200Success
401Unauthorized
500Server Error