# Get Orders

Returns a collection of Orders.

## Request

HTTP Method: `GET`

URI Path: `/v3/orders`

Note

For all returned data attributes, see [Order Object](order-object.html).

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| filter[<filter\_name>] | `string`, `DateTime` | No | [Filtering](../../../specification/filtering.html#api-filters) |
| fields[orders] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) |
| sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) |
| page[number] | `integer` | No | [Page number](../../../specification/pagination.html#api-pagination). |
| page[size] | `integer` | No | [Page size](../../../specification/pagination.html#api-pagination). 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 | Order `id` field. |
| status | `string` | Yes | Yes | Order `status` field. Possible values: `pending`, `completed`, `canceled`. |
| created\_at\_gteq | `DateTime` | No | No | The `created_at_gteq` field. |
| created\_at\_lteq | `DateTime` | No | No | The `created_at_lteq` field. |
| reference | `string` | No | Yes | Order `reference` field. |
| external\_reference\_id | `string` | No | No | The `external_reference_id` field. |

### Sorting

| Value | Sorts by: |
| --- | --- |
| status | The `status` field. Possible values: `pending`, `completed`, `canceled`. |
| amount | The `amount` field. |
| created\_at | The `created_at` field. |
| reference | The `reference` field. |
| external\_reference\_id | The `external_reference_id` field. |

## Examples

DID Order ItemsEmergency Order Items

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/orders 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/orders -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": "d9fb4666-cf4b-4409-8144-cb7535924db8",
 8            "type": "orders",
 9            "attributes": {
10                "amount": "6.0",
11                "status": "completed",
12                "created_at": "2023-10-26T11:06:28.989Z",
13                "description": "DID",
14                "reference": "EBX-118849",
15                "external_reference_id": null,
16                "items": [
17                    {
18                        "type": "did_order_items",
19                        "attributes": {
20                            "qty": 1,
21                            "nrc": "0.0",
22                            "mrc": "5.0",
23                            "prorated_mrc": false,
24                            "billed_from": "2023-10-26",
25                            "billed_to": "2023-11-26",
26                            "setup_price": "0.0",
27                            "monthly_price": "5.0",
28                            "did_group_id": "2ef40a84-dfd4-45bb-8519-b4a7ebb74453"
29                        }
30                    }
31                ],
32                "callback_method": null,
33                "callback_url": null
34            }
35        }
36    ],
37    "meta": {
38        "total_records": 1,
39        "api_version": "2026-11-19"
40    },
41    "links": {
42        "first": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50",
43        "last": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50"
44    }
45}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/orders 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/orders -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": "103e98b9-509c-4dcb-8c6d-88fa491948df",
 8            "type": "orders",
 9            "attributes": {
10                "amount": "3.0",
11                "status": "completed",
12                "created_at": "2026-03-05T13:44:19.396Z",
13                "description": "Emergency",
14                "reference": "OUZ-611729",
15                "external_reference_id": null,
16                "items": [
17                    {
18                        "type": "emergency_order_items",
19                        "attributes": {
20                            "qty": 1,
21                            "nrc": "1.5",
22                            "mrc": "1.5",
23                            "prorated_mrc": false,
24                            "billed_from": "2026-03-05",
25                            "billed_to": "2026-04-04",
26                            "emergency_calling_service_id": "dba34c89-6cd5-403c-b284-f7d5ae33c5d7"
27                        }
28                    }
29                ],
30                "callback_method": null,
31                "callback_url": null
32            }
33        }
34    ],
35    "meta": {
36        "total_records": 1,
37        "api_version": "2026-11-19"
38    },
39    "links": {
40        "first": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50",
41        "last": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50"
42    }
43}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request) |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 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. |
