Notification

Get all in-app notification of the requesting user.

Changed on

Returns the paginated list of in-app notifications

get/v1/notifications

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/notifications
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: notification.read)

Query parameters

page_sizeinteger

Maximum number of items to return.

page_tokenstring

Opaque continuation token from a previous page_info.next_page_token.

Response

OK

Example response

{
  "items": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "title": "Do something great",
      "description": "Make the world a better place!"
    }
  ]
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6965ecf3ab92Revision changes
    • breaking

      the response's body type changed from array to object for status

    • warning

      deleted the query request parameter limit

    • warning

      deleted the query request parameter offset

    • info

      added the new optional query request parameter page_size

    • info

      added the new optional query request parameter page_token

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status