---
title: "GET /api/admin/deliveries/"
method: GET
path: "/api/admin/deliveries/"
tags: ["Deliveries"]
---

# GET /api/admin/deliveries/

`GET /api/admin/deliveries/`

Search through deliveries.

## Query parameters

- `workspaceId` string, required
- `fromIdentifier` string
- `toIdentifier` string
- `journeyId` string
- `userId` union
  - string — Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.
  - string[]
- `channels` union[]
  - union
    - 'Email'
    - 'MobilePush'
    - 'Sms'
    - 'Webhook'
- `limit` number
- `cursor` string
- `from` string[]
- `to` string[]
- `statuses` string[]
- `templateIds` string[]
- `startDate` string
- `endDate` string
- `sortBy` union
  - 'from'
  - 'to'
  - 'status'
  - 'sentAt'
- `sortDirection` union
  - 'Asc'
  - 'Desc'
- `broadcastId` string
- `triggeringProperties` object[]
  - `key` string, required
  - `value` union, required
    - string
    - number
- `groupId` union
  - string
  - string[]
- `contextValues` object[]
  - `key` string, required
  - `value` union, required
    - string
    - number

## Response `200`

Default Response

- object
  - `workspaceId` string, required
  - `items` union[], required
    - union
      - object
        - `status` string, required
        - `variant` object, required
          - `type` 'Sms', required
          - `provider` union, required
            - object
              - …
            - object
              - …
            - object
              - …
          - `to` string, required
          - `body` string, required
        - `sentAt` string, required
        - `updatedAt` string, required
        - `journeyId` string
        - `broadcastId` string
        - `userId` string, required — Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.
        - `isAnonymous` boolean
        - `originMessageId` string, required
        - `triggeringMessageId` string
        - `templateId` string, required
      - object
        - `status` union, required
          - 'DFInternalMessageSent'
          - 'DFEmailDropped'
          - 'DFEmailDelivered'
          - 'DFEmailOpened'
          - 'DFEmailClicked'
          - 'DFEmailBounced'
          - 'DFEmailMarkedSpam'
        - `variant` object, required
          - `type` 'Email', required
          - `provider` union, required
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `to` string, required
          - `headers` object
          - `attachments` object[]
            - `mimeType` string, required
            - `name` string, required
          - `from` string, required
          - `subject` string, required
          - `replyTo` string
          - `cc` string
          - `bcc` string
          - `name` string
          - `attachmentUserProperties` string[] — Names of user properties to attach to the email as attachments.
          - `emailContentsType` 'Code'
          - `body` string, required
        - `sentAt` string, required
        - `updatedAt` string, required
        - `journeyId` string
        - `broadcastId` string
        - `userId` string, required — Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.
        - `isAnonymous` boolean
        - `originMessageId` string, required
        - `triggeringMessageId` string
        - `templateId` string, required
      - object
        - `status` string, required
        - `variant` object, required
          - `type` 'Webhook', required
          - `to` string, required
          - `request` object, required
            - `url` string
            - `method` string
            - `headers` object
            - `params` unknown
            - `data` unknown
            - `responseType` union
              - …
          - `response` object, required
            - `status` number
            - `headers` object
            - `body` unknown
        - `sentAt` string, required
        - `updatedAt` string, required
        - `journeyId` string
        - `broadcastId` string
        - `userId` string, required — Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.
        - `isAnonymous` boolean
        - `originMessageId` string, required
        - `triggeringMessageId` string
        - `templateId` string, required
      - object
        - `status` union, required
          - 'DFInternalMessageSent'
          - 'DFEmailDropped'
          - 'DFEmailDelivered'
          - 'DFEmailOpened'
          - 'DFEmailClicked'
          - 'DFEmailBounced'
          - 'DFEmailMarkedSpam'
        - `to` string, required
        - `channel` 'Email', required
        - `from` string
        - `subject` string
        - `replyTo` string
        - `cc` string
        - `bcc` string
        - `name` string
        - `headers` object[]
          - `name` string, required
          - `value` string, required
        - `attachmentUserProperties` string[] — Names of user properties to attach to the email as attachments.
        - `emailContentsType` 'Code'
        - `body` string
        - `sentAt` string, required
        - `updatedAt` string, required
        - `journeyId` string
        - `broadcastId` string
        - `userId` string, required — Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.
        - `isAnonymous` boolean
        - `originMessageId` string, required
        - `triggeringMessageId` string
        - `templateId` string, required
  - `cursor` string
  - `previousCursor` string

---

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