Skip to main content

List Notifications

GET 
/v1/notifications
Tag: api-baas-get-all-bell-notificationsDescription: Retrieve a list of notifications related to the logged or target user.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Sort attribute for paging.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses​

Successfully retrieved notifications by user.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Notification data.

  • Array [
    • id stringrequired

    Notification UUID.

    user_id stringrequired

    User UUID.

    title stringrequired

    Notification title.

    description stringrequired

    Notification description.

    read booleanrequired

    Indicates if the notification has been read.

    created_at date-timerequired

    Notification created at.

  • ]
Loading...