Skip to content

List notifications

Pages the customer's notifications about new content, newest first, with whether each is read.

Needs the read scope.

Pages its answer: pass the cursor back for the next page, at most 100 items a page.

Filters: read (eq), type (eq, in).

Sorts: created.

Call

  • Tool: list_notifications
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
query object No
{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "properties": {
            "read": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "boolean"
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            },
            "type": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "portfolio_trade",
                    "new_lesson",
                    "new_episode",
                    "new_post",
                    "new_file",
                    "new_product",
                    "new_discount",
                    "event_reminder",
                    "event_follow_up"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string",
                      "enum": [
                        "portfolio_trade",
                        "new_lesson",
                        "new_episode",
                        "new_post",
                        "new_file",
                        "new_product",
                        "new_discount",
                        "event_reminder",
                        "event_follow_up"
                      ]
                    },
                    "in": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "portfolio_trade",
                          "new_lesson",
                          "new_episode",
                          "new_post",
                          "new_file",
                          "new_product",
                          "new_discount",
                          "event_reminder",
                          "event_follow_up"
                        ]
                      },
                      "minItems": 1,
                      "maxItems": 50
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            }
          },
          "additionalProperties": false
        },
        "sort": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "enum": [
                "created"
              ]
            },
            "direction": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          "additionalProperties": false
        },
        "limit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "cursor": {
          "type": "string",
          "maxLength": 8192
        },
        "count": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Answer

Name Type Required Description
items array of object Yes
cursor string or null Yes
total number No
facets object No

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close