Skip to content
Docs
Select language:English

/api/v1/notifications

GET
/api/v1/notifications
curl --request GET \
  --url 'https://example.com/api/v1/notifications?limit=20&unread=0&kind=reminder'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 200
cursor
string
<= 2048 characters
unread
string
Allowed values: 0 1 true false
kind
string
Allowed values: reminder membership_added membership_ended ai_cap ai_summary export_ready
locationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: reminder membership_added membership_ended ai_cap ai_summary export_ready
createdAt
required
string
readAt
required
string | null
locationId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
reminder
object
occurrenceId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
sourceType
required
string
Allowed values: schedule warranty registration document loan thing_expiry reading_stale stock
sourceId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: due overdue expiring
dueOn
required
string | null
dueValue
required
string | null
state
required
string
Allowed values: open done superseded cancelled
subject
required
object
type
required
string
Allowed values: thing place location
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
path
required
string
shortCode
string | null
title
required
string
actions
required
Array<string>
Allowed values: complete snooze mark_returned renew open
membership
object
userName
required
string
role
required
string
Allowed values: owner admin member viewer
locationName
required
string
aiCap
object
scope
required
string
Allowed values: instance instance_account account location member user
level
required
Any of:
number
Allowed values: 80
month
required
string
exportReady
object
runId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: claim_pack insurance_report location me
unread
required
integer
>= -9007199254740991 <= 9007199254740991
next_cursor
required
string | null
Example
{
  "items": [
    {
      "kind": "reminder",
      "reminder": {
        "sourceType": "schedule",
        "kind": "due",
        "state": "open",
        "subject": {
          "type": "thing"
        },
        "actions": [
          "complete"
        ]
      },
      "membership": {
        "role": "owner"
      },
      "aiCap": {
        "scope": "instance",
        "level": 80
      },
      "exportReady": {
        "kind": "claim_pack"
      }
    }
  ]
}