Skip to main content
GET
/
api
/
v1
/
uploads
List uploads
curl --request GET \
  --url https://api.optimaldial.com/api/v1/uploads \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "original_filename": "<string>",
      "storage_path": "<string>",
      "status": "pending_mapping",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "file_size_bytes": 123,
      "valid_row_count": 123,
      "invalid_row_count": 123,
      "credits_required": 123,
      "credits_charged": 123,
      "credits_refunded": 123,
      "source": "web",
      "api_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "skip_mobile_lookup": true,
      "processed_storage_path": "<string>",
      "processed_filtered_storage_path": "<string>",
      "error_message": "<string>",
      "exceeded_daily_limit": true
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

OptimalDial API key, prefixed od_live_, sent as Authorization: Bearer .... Mint keys in the in-app developer panel; they are scoped to a single organization.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string

Opaque cursor returned as next_cursor in the previous response.

Response

A page of uploads.

data
object[]
required
next_cursor
string | null
required