Get DID Histories#

Returns a list of DID history records for your account. Only records from the last 90 days are available.

Request#

HTTP Method: GET

URI Path: /v3/did_history

Note

For all returned data attributes, see Did History Object.

URI Query Parameters#

Name

Type

Is Required?

Description

filter[<filter_name>]

string

No

Filtering

fields[did_history]

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#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

The DID history UUID.

did_number

string

No

No

The DID number.

action

string

No

No

The action value.

method

string

No

No

The method value.

created_at_gteq

string

No

No

Records created on or after the specified date and time.

created_at_lteq

string

No

No

Records created on or before the specified date and time.

Available Action Values#

Value

Description

assigned

DID assignment event.

renewed

DID renewal event.

canceled

DID cancellation event.

removed

DID release or removal event.

billing_cycles_count_changed

Billing cycles count change event.

restored

DID restoration event.

Note

The meta.from and meta.to values are returned only for billing_cycles_count_changed records.

Available Method Values#

Value

Description

system

Action performed by the system.

api2

Action performed through API v2.

api3

Action performed through API v3.

staff

Action performed by staff.

user_panel

Action performed from the user panel.

mcp

Changed through the MCP server.

Sorting#

Value

Sorts by:

created_at

Creation timestamp

Examples#

http

1GET /v3/did_history 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/did_history -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": "9e3b65e9-fdc4-1810-9e93-b7127ab6b976",
 8            "type": "did_history",
 9            "attributes": {
10                "did_number": "437xxxxxxxxx",
11                "action": "removed",
12                "method": "api3",
13                "created_at": "2026-03-06T15:11:00.326Z"
14            }
15        },
16        {
17            "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
18            "type": "did_history",
19            "attributes": {
20                "did_number": "437xxxxxxxxx",
21                "action": "renewed",
22                "method": "api2",
23                "created_at": "2026-04-16T11:30:00.000Z"
24            }
25        },
26        {
27            "id": "9e3b65e9-fdc4-1810-9e93-b7127ab59ee6",
28            "type": "did_history",
29            "attributes": {
30                "did_number": "437xxxxxxxxx",
31                "action": "billing_cycles_count_changed",
32                "method": "staff",
33                "created_at": "2026-04-03T17:42:45.728Z"
34            },
35            "meta": {
36                "from": "empty",
37                "to": "5"
38            }
39        }
40    ],
41    "links": {
42        "first": "https://api.didww.com/v3/did_history?page%5Bnumber%5D=1&page%5Bsize%5D=50",
43        "last": "https://api.didww.com/v3/did_history?page%5Bnumber%5D=1&page%5Bsize%5D=50"
44    },
45    "meta": {
46        "total_records": 3,
47        "api_version": "2026-11-19"
48    }
49}

Other Responses#

Code

Success

Description

400

No

Invalid filter value, invalid sort criteria, or the created_at filter date is outside the last 90 days.

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.