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

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.

Examples:

"1043"

"user-123"

"0a58e5e4-c753-477e-a6c4-f9b0e3396b9b"

​
channels
enum<string>[]
​
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

Response

200 - application/json

Default Response

The response is of type object.

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

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.

Examples:

"1043"

"user-123"

"0a58e5e4-c753-477e-a6c4-f9b0e3396b9b"

​
channels
enum<string>[]
​
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

Response

200 - application/json

Default Response

The response is of type object.