# 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) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| id | `string` | No | Yes | Order `id` field. |
| status | `Array[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 | `Array[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. |
| description | The `description` field. |

## Examples

DID Order ItemsEmergency Order Items

[[DIDWW-API-EXAMPLE-START]]

http

```
GET /v3/orders 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/orders -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": "d9fb4666-cf4b-4409-8144-cb7535924db8",
            "type": "orders",
            "attributes": {
                "amount": "6.0",
                "status": "completed",
                "created_at": "2023-10-26T11:06:28.989Z",
                "description": "DID",
                "reference": "EBX-118849",
                "external_reference_id": null,
                "items": [
                    {
                        "type": "did_order_items",
                        "attributes": {
                            "qty": 1,
                            "nrc": "0.0",
                            "mrc": "5.0",
                            "prorated_mrc": false,
                            "billed_from": "2023-10-26",
                            "billed_to": "2023-11-26",
                            "did_group_id": "2ef40a84-dfd4-45bb-8519-b4a7ebb74453"
                        }
                    }
                ],
                "callback_method": null,
                "callback_url": null
            }
        }
    ],
    "meta": {
        "total_records": 1,
        "api_version": "2026-04-16"
    },
    "links": {
        "first": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "last": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
GET /v3/orders 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/orders -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": "103e98b9-509c-4dcb-8c6d-88fa491948df",
            "type": "orders",
            "attributes": {
                "amount": "3.0",
                "status": "completed",
                "created_at": "2026-03-05T13:44:19.396Z",
                "description": "Emergency",
                "reference": "OUZ-611729",
                "external_reference_id": null,
                "items": [
                    {
                        "type": "emergency_order_items",
                        "attributes": {
                            "qty": 1,
                            "nrc": "1.5",
                            "mrc": "1.5",
                            "prorated_mrc": false,
                            "billed_from": "2026-03-05",
                            "billed_to": "2026-04-04",
                            "emergency_calling_service_id": "dba34c89-6cd5-403c-b284-f7d5ae33c5d7"
                        }
                    }
                ],
                "callback_method": null,
                "callback_url": null
            }
        }
    ],
    "meta": {
        "total_records": 1,
        "api_version": "2026-04-16"
    },
    "links": {
        "first": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "last": "https://api.didww.com/v3/orders?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 404 | No | [Not Found](../../../specification/errors/index.html#api-not-found) |
| 401 | No | [Unauthorized](../../../configuration.html#api-key) |

On this page