Get an organization notification history item

GET

/api/notifications/history/{source}/{id}

curl --request GET \
  --url https://api.getvespy.com/api/notifications/history/notification/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

source

required

string

Allowed values: notification blast_recipient

id

required

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

item

required

object

actorUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

actorUserId

required

string format: uuid

nullable

body

required

string

nullable

channels

required

Array<string>

>= 1 items

Allowed values: in_app email sms push

createdAt

required

string format: date-time

deliveries

required

Array<object>

>= 1 items

object

channel

required

string

Allowed values: in_app email sms push

deliveredAt

required

string format: date-time

nullable

deliveryMode

required

string

nullable

Allowed values: immediate daily_digest

destination

required

string

nullable

sentAt

required

string format: date-time

nullable

state

required

string

Allowed values: delivered queued pending dispatched failed

entityId

required

string format: uuid

nullable

entityType

required

string

nullable

id

required

string format: uuid

priority

required

string

Allowed values: low normal high urgent

recipient

required

object

email

required

string format: email

nullable

fullName

required

string

nullable >= 1 characters <= 160 characters

phone

required

string

nullable

recipientId

required

string format: uuid

recipientType

required

string

Allowed values: user tenant

role

required

string

nullable

Allowed values: admin manager staff tenant owner vendor

tenantId

required

string format: uuid

nullable

userId

required

string format: uuid

nullable

source

required

string

Allowed values: notification blast_recipient

title

required

string

>= 1 characters

type

required

string

>= 1 characters

Example

{
  "item": {
    "channels": [
      "in_app"
    ],
    "deliveries": [
      {
        "channel": "in_app",
        "deliveryMode": "immediate",
        "state": "delivered"
      }
    ],
    "priority": "low",
    "recipient": {
      "recipientType": "user",
      "role": "admin"
    },
    "source": "notification"
  }
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}