---
title: "Retrieve a list of delivery reports"
method: GET
path: "/xms/v1/{service_plan_id}/delivery_reports"
tags: ["Delivery reports"]
---

# Retrieve a list of delivery reports

`GET /xms/v1/{service_plan_id}/delivery_reports`

Get a list of finished delivery reports.

This operation supports pagination.

## Query parameters

- `page` integer
- `page_size` integer
- `start_date` string, date-time
- `end_date` string, date-time
- `status` DeliveryStatus[]
- `code` DeliveryReceiptStatusCode[]
- `client_reference` string

## Response `200`

A successful response , or an [Error](https://developers.sinch.com/docs/sms/api-reference/status-codes).

- DeliveryReportList
  - `count` integer — The total number of entries matching the given filters.
  - `page` integer — The requested page.
  - `page_size` integer — The number of entries returned in this request.
  - `delivery_reports` RecipientDeliveryReport[] — The page of delivery reports matching the given filters.
    - `applied_originator` string — The default originator used for the recipient this delivery report belongs to, if default originator pool configured and no originator set when submitting batch.
    - `at` string, date-time, required — A timestamp of when the Delivery Report was created in the Sinch service. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.
    - `batch_id` string, required — The ID of the batch this delivery report belongs to
    - `client_reference` string — The client identifier of the batch this delivery report belongs to, if set when submitting batch.
    - `code` 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418, required — The delivery report status code provides a more detailed view of what happened with a message. The REST API error codes are a combination of [SMPP error codes](https://developers.sinch.com/docs/sms/smpp/error-codes/#status-reports-error-codes), [MMS error codes](https://developers.sinch.com/docs/mms/7-service/mms-status-codes/) and custom codes.
    - `encoding` 'GSM' | 'UNICODE' — Applied encoding for message. Present only if smart encoding is enabled.
    - `number_of_message_parts` integer — The number of parts the message was split into. Present only if `max_number_of_message_parts` parameter was set.
    - `operator` string — The operator that was used for delivering the message to this recipient, if enabled on the account by Sinch.
    - `operator_status_at` string, date-time — A timestamp extracted from the Delivery Receipt from the originating SMSC. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.
    - `recipient` string, required — Phone number that was queried.
    - `status` 'Queued' | 'Dispatched' | 'Aborted' | 'Cancelled' | 'Failed' | 'Delivered' | 'Expired' | 'Rejected' | 'Deleted' | 'Unknown', required — The simplified status as described in _Delivery Report Statuses_.
    - `type` 'recipient_delivery_report_sms' | 'recipient_delivery_report_mms', required — The recipient delivery report type.

## Other responses

- `400` — Bad request

---

[API](https://skmtc.net/sinch/apis/api-overview-sinch.md) · [All operations](https://skmtc.net/sinch/apis/api-overview-sinch/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/api-overview-sinch/revisions/67cb925f1c81/schema)