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. Pagination defaults to 50 records per page. The maximum is 100.

Filters#

The collection includes Exports of every type, including Exports created with earlier API versions. A filter on export_type also matches those earlier Exports of the same type.

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

The Export ID.

external_reference_id

string

No

No

The external_reference_id field.

export_type

string

No

Yes

The export_type field. Possible values: cdr_in, cdr_out, sms_in, sms_out.

status

string

No

Yes

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

created_at_gteq

string

No

No

Exports created on or after the specified date and time.

created_at_lteq

string

No

No

Exports created on or before the specified date and time.

Filters that allow an array accept a comma-separated list of values, for example filter[export_type]=sms_in,sms_out. An Export matches when it matches any listed value.

Sorting#

Value

Description

status

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

created_at

The created_at field.

external_reference_id

The external_reference_id field.

Examples#

http

1GET /v3/exports?filter%5Bexport_type%5D=cdr_in HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]

curl

1curl -i -X GET 'https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_in' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": [
 6    {
 7      "id": "6fee87b1-5f86-470c-80ca-9c3922653de9",
 8      "type": "exports",
 9      "attributes": {
10        "status": "processing",
11        "created_at": "2026-10-13T20:02:07.798Z",
12        "external_reference_id": null,
13        "url": null,
14        "callback_url": null,
15        "callback_method": null,
16        "export_type": "cdr_in",
17        "filters": {
18          "from": "2026-09-01 00:00:00",
19          "to": "2026-09-30 23:59:59",
20          "did_number": "123456789"
21        }
22      }
23    },
24    {
25      "id": "33bdfff7-4de3-4c58-8c90-b99930fb984a",
26      "type": "exports",
27      "attributes": {
28        "status": "processing",
29        "created_at": "2026-10-16T06:39:44.465Z",
30        "external_reference_id": null,
31        "url": null,
32        "callback_url": null,
33        "callback_method": null,
34        "export_type": "cdr_in",
35        "filters": {
36          "from": "2026-09-01 00:00:00",
37          "to": "2026-09-30 23:59:59",
38          "did_number": "123456789"
39        }
40      }
41    },
42    {
43      "id": "d4f37476-8ece-4add-bbcb-cc72a7908fe2",
44      "type": "exports",
45      "attributes": {
46        "status": "processing",
47        "created_at": "2026-10-16T06:54:30.122Z",
48        "external_reference_id": null,
49        "url": null,
50        "callback_url": "http://example.com",
51        "callback_method": "get",
52        "export_type": "cdr_in",
53        "filters": {
54          "from": "2026-09-01 00:00:00",
55          "to": "2026-09-30 23:59:59",
56          "did_number": "123456789"
57        }
58      }
59    }
60  ],
61  "meta": {
62    "total_records": 3,
63    "api_version": "2026-11-19"
64  },
65  "links": {
66    "first": "https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_in&page%5Bnumber%5D=1&page%5Bsize%5D=50",
67    "last": "https://api.didww.com/v3/exports?filter%5Bexport_type%5D=cdr_in&page%5Bnumber%5D=1&page%5Bsize%5D=50"
68  }
69}

Other Responses#

Code

Success

Description

400

No

Bad Request

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.