Skip to content
Vespy API

List notification blasts

GET
/api/notifications/blasts
curl --request GET \
  --url 'https://api.getvespy.com/api/notifications/blasts?status=draft' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: draft scheduled queued sending completed failed
search
string
>= 1 characters <= 100 characters
limit
integer
>= 1 <= 100
offset
integer

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
items
required
Array<object>
object
actorUser
required
object
fullName
required
string
>= 1 characters <= 160 characters
id
required
string format: uuid
autoTranslate
required
boolean
body
required
string
>= 1 characters <= 4000 characters
channels
required
Array<string>
Allowed values: in_app email sms
completedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
error
required
string
nullable
id
required
string format: uuid
languageCount
required
integer
queuedAt
required
string format: date-time
nullable
recipientCount
required
integer
recipientCountIsEstimate
required
boolean
scheduledAt
required
string format: date-time
nullable
skippedUnlinkedTenantCount
required
integer
status
required
string
Allowed values: draft scheduled queued sending completed failed
title
required
string
>= 1 characters <= 160 characters
updatedAt
required
string format: date-time
total
required
integer
Example
{
  "items": [
    {
      "channels": [
        "in_app"
      ],
      "status": "draft"
    }
  ]
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}