GET
/
files
List Files
curl --request GET \
  --url https://api.callhq.ai/api/files \
  --header 'x-api-key: <api-key>'
{
  "files": [
    {
      "id": "<string>",
      "externalId": "<string>",
      "name": "<string>",
      "integrationId": "<string>",
      "url": "<string>",
      "bytes": 123,
      "object": "<string>",
      "purpose": "<string>",
      "mimetype": "<string>",
      "bucket": "<string>",
      "path": "<string>",
      "status": "<string>",
      "parsedTextUrl": "<string>",
      "parsedTextBytes": "<string>",
      "organizationId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "organization": {
        "id": "<string>",
        "name": "<string>"
      },
      "integration": {}
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination.

limit
integer
default:10

Maximum number of files to return per page.

Response

200
application/json

List of files retrieved successfully.

The response is of type object.