Get Exports

Returns a collection of Exports.

Request

HTTP Method: GET

URI Path: /v3/exports

Note

For all returned data attributes, see Export Object.

URI Query Parameters

Name

Type

Is Required?

Description

filter[<filter_name>]

string

No

Filtering

fields[exports]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size.

Filters

The external_reference_id filter applies to all export types. Other filters differ depending on the export_type Data attribute.

Filter Name

Type

Allow Blank

Allow Array

Filters by:

external_reference_id

string

No

No

The external_reference_id field.

Filter Name

Type

Allow Blank

Allow Array

Filters by:

from

string

No

No

The start date and time of the CDR range.

to

string

No

No

The end date and time of the CDR range.

did_number

string

Yes

No

The DID number used to filter inbound CDR exports.

Sorting

Value

Description

status

The status field. Possible values: pending, processing, completed.

created_at

The created_at field.

Examples

http

GET /v3/exports HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i -X GET https://api.didww.com/v3/exports -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "6fee87b1-5f86-470c-80ca-9c3922653de9",
      "type": "exports",
      "attributes": {
        "status": "processing",
        "created_at": "2025-12-13T20:02:07.798Z",
        "external_reference_id": null,
        "url": null,
        "callback_url": null,
        "callback_method": null,
        "export_type": "cdr_in",
        "filters": {
          "from": "2025-12-01 00:00:00",
          "to": "2025-12-31 23:59:59",
          "did_number": "123456789"
        }
      }
    },
    {
      "id": "33bdfff7-4de3-4c58-8c90-b99930fb984a",
      "type": "exports",
      "attributes": {
        "status": "processing",
        "created_at": "2025-12-16T06:39:44.465Z",
        "external_reference_id": null,
        "url": null,
        "callback_url": null,
        "callback_method": null,
        "export_type": "cdr_in",
        "filters": {
          "from": "2025-12-01 00:00:00",
          "to": "2025-12-31 23:59:59",
          "did_number": "123456789"
        }
      }
    },
    {
      "id": "d4f37476-8ece-4add-bbcb-cc72a7908fe2",
      "type": "exports",
      "attributes": {
        "status": "processing",
        "created_at": "2025-12-16T06:54:30.122Z",
        "external_reference_id": null,
        "url": null,
        "callback_url": "http://example.com",
        "callback_method": "get",
        "export_type": "cdr_in",
        "filters": {
          "from": "2025-12-01 00:00:00",
          "to": "2025-12-31 23:59:59",
          "did_number": "123456789"
        }
      }
    }
  ],
  "meta": {
    "total_records": 3,
    "api_version": "2026-04-16"
  },
  "links": {
    "first": "https://api.didww.com/v3/exports?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "https://api.didww.com/v3/exports?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}

Other Responses

Code

Success

Description

401

No

Unauthorized