Notifications

Get Inbox

Retrieves all inbox notification entries for the currently authenticated user.

get/api/notification/v1/inbox

Query parameters

languagestring

language code for multilingual fields. Must be supported by application.

pageinteger

page number

searchTermstring

string to search for in the resource

sizeinteger

page size

sortByobject

List of field names to sort by. Default is ascending prefix with - for descending

Response

OK

totalItemsinteger required

Total number of items across all pages.

totalPagesinteger required

Total number of pages available.

currentPageinteger required

Current page number (0-based ).

pageSizeinteger required

Number of items per page.

Example response

{
  "items": [
    {
      "createdAt": "2022-03-10T12:15:50"
    }
  ],
  "totalItems": 42,
  "totalPages": 5,
  "currentPage": 1,
  "pageSize": 10
}

Changes

Changed in 6 of the 56 revisions of this API.126

    • added the new optional query request parameter language

      new-optional-request-parameter

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

    • removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 404

      response-property-enum-value-removed

    • removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 500

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7cee7b14bf6f22See the full diff
    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the optional property items/items/targetId to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/targetType to the response with the 200 status

      response-optional-property-added

    • added the new OTP_EXPIRED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_EXPIRED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_INVALID enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_INVALID enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_LOCKED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_LOCKED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 500

      response-property-enum-value-added

    • endpoint added

      endpoint-added