api-docs v5.67.0

API Docs

Notification

Notification - Find

Back to top

Get list of notifications

GET /notifications

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/notifications" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
notifications object[]

array of notification
notifications.id string
notifications.createdAt number
notifications.code string

new-queue-item, etc.
notifications.type string

warehouse, etc.
notifications.title string
notifications.body string
notifications.meta object

for use by apps depending on the type
notifications.seenBy string[]

seeners account id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "direction": "inbound"
  },
  {
    "id": "id-2",
    "direction": "outbound"
  }
]

Notification - Get

Back to top

Get a specific notification

GET /notifications/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/notifications/<notification-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
code string

new-queue-item, etc.
type string

warehouse, etc.
title string
body string
meta object

for use by apps depending on the type
seenBy string[]

seeners account id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "direction": "inbound"
}

results matching ""

    No results matching ""