v1

latestOpenAPI 3.1.02026-07-26461279.9 KB
Deliveries

Search through deliveries.

get/api/admin/deliveries/

Query parameters

workspaceIdstring required
fromIdentifierstring
toIdentifierstring
journeyIdstring
string

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

OR
string[]
Example:1043
limitnumber
cursorstring
fromstring[]
tostring[]
statusesstring[]
templateIdsstring[]
startDatestring
endDatestring
'from'
OR
'to'
OR
'status'
OR
'sentAt'
'Asc'
OR
'Desc'
broadcastIdstring
keystring required
string
OR
string[]
keystring required

Response

Default Response

workspaceIdstring required
cursorstring
previousCursorstring

Example response

{
  "items": [
    {
      "userId": "1043"
    }
  ]
}