Skip to main content
GET
/
api
/
admin
/
deliveries
cURL
curl --request GET \
  --url http://localhost:3001/api/admin/deliveries/ \
  --header 'Authorization: <api-key>'
{
  "workspaceId": "<string>",
  "items": [
    {
      "status": "<string>",
      "variant": {
        "type": "Sms",
        "provider": {
          "type": "Twilio",
          "sid": "<string>"
        },
        "to": "<string>",
        "body": "<string>"
      },
      "sentAt": "<string>",
      "updatedAt": "<string>",
      "userId": "<string>",
      "originMessageId": "<string>",
      "templateId": "<string>",
      "journeyId": "<string>",
      "broadcastId": "<string>",
      "isAnonymous": true,
      "triggeringMessageId": "<string>"
    }
  ],
  "cursor": "<string>",
  "previousCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Query Parameters

workspaceId
string
required
fromIdentifier
string
toIdentifier
string
journeyId
string
userId

Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.

Example:

"1043"

channels
enum<string>[]
Available options:
Email
limit
number
cursor
string
from
string[]
to
string[]
statuses
string[]
templateIds
string[]
startDate
string
endDate
string
sortBy
Available options:
from
sortDirection
Available options:
Asc
broadcastId
string
triggeringProperties
object[]
groupId
contextValues
object[]

Response

200 - application/json

Default Response

workspaceId
string
required
items
object[]
required
  • Option 1
  • Option 2
  • Option 3
  • Option 4
cursor
string
previousCursor
string