notifications

Get notifications

Changed on

Get all notifications received by the current user. By default returns the 20 most recent notifications.

get/api/notifications

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/notifications
  • Auth: HTTP bearer

Query parameters

limitinteger

Number of notifications to return (default: 20, most recent)

cursorstring nullable

Cursor for the next page.

notification_typestring nullable

Filter by notification type (chat, booking, payment, subscription, event, general, daily_morning, daily_evening)

success_onlyboolean nullable

Filter by success status (true for successful only, false for failed only, null for all)

Response

Successful Response

totalinteger required

Total number of notifications

next_cursorstring nullable

Cursor for the next page.

has_moreboolean

Whether there are more results after this page

Example response

{
  "has_more": true,
  "next_cursor": "eyJpZCI6IjEyM2U0NTY3LWU4OWItMTJkMy1hNDU2LTQyNjYxNDE3NDAwMCIsInNlbnRfYXQiOiIyMDI0LTAxLTAxVDEyOjAwOjAwWiJ9",
  "notifications": [
    {
      "body": "You have a new message",
      "data": {
        "chat_id": "123e4567-e89b-12d3-a456-426614174002",
        "type": "chat"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "notification_metadata": {
        "chat_id": "123e4567-e89b-12d3-a456-426614174002"
      },
      "notification_type": "chat",
      "push_token": "fGhJkLmNoPqRsTu...",
      "sent_at": "2024-01-01T12:00:00Z",
      "success": true,
      "title": "New message",
      "user_id": "123e4567-e89b-12d3-a456-426614174001"
    }
  ],
  "total": 100
}

Changes

  • b1a8bee57dc2Revision changes
    • warning

      added the new community enum value to the // response property for the response status

  • f23730d7b735Revision changes
    • warning

      added the new clinical_document enum value to the // response property for the response status