List your notifications

GET/v1/api/store/{team_slug}/current_user_feed

v1Operation ID v1_public_current_user_feed_index

Lists your notifications on this team, newest first: activity that concerns you, such as new comments, customer replies, payments received and approvals answered.

By default only unseen, unarchived items are returned. Send not_seen_yet=0 to include seen items, and show_archive=1 to include archived ones too (it adds them; it does not return only archived items). The page size is your team's list size setting (50 unless changed).

Customer Portal payment notifications (type customer_payment) are listed only when your role may see that customer's finances; others are left out of the page and of the total.

Permission

Your own feed only: the key's owner. Payment notifications need more, see the rules.

Business rules

• not_seen_yet and show_archive take 1 or 0. true and false are refused.
• A customer_payment notification is listed for the team owner, or for a role with View Customer Sales Aggregates and Manage Customers ("Manage All", or "Manage Assigned to User" when the customer is assigned to you). Its payment.affected_orders lists only the orders you may see, and none without View Sales Order Pricing.
• Access is checked again for each row: if you lose access after a payment notification was listed, it comes back with action payment_access_changed, message_key customer_payment.payment_access_changed and object [].
• A key whose user is no longer a member of the team gets an empty list.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Query parameters

• not_seen_yetinteger

  1 (default): only unseen items. 0: seen and unseen.

  • One of: 0, 1
  • Default 1
  • Example 0
• show_archiveinteger

  0 (default): leave out archived items. 1: include them.

  • One of: 0, 1
  • Default 0
  • Example 0
• pageinteger
  • Default 1
  • Minimum 1

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (5)

  • activityobject

    What happened.

    Child fields (7)

    • actionstring

      What happened. For customer_payment: dispute_opened, dispute_under_review, dispute_won, funds_withheld, chargeback_confirmed, payment_reversed, payment_needs_attention, deadline_approaching, deadline_overdue, funds_released, funds_restored, case_won_awaiting_funds, payment_resolved, provider_refund_applied or provider_refund_failed; payment_access_changed when you can no longer see that payment.

    • created_atstring (date-time)
    • idstring
    • message_keystring

      Identifies the kind of notification, for your own wording: <type>.<action>, such as order.new_comment.

    • objectobject | array

      The details, which depend on the kind: for example the order, the comment and who wrote it (user: id, name, avatar_url). An empty array [] when there are none. For customer_payment, the payment as it was then (payment, with the orders it touched in payment.affected_orders, limited to the ones you may see); [] when you can no longer see that payment.

    • teamobject
      Child fields (3)

      • idstring
      • namestring
      • slugstring
    • typestring

      What the notification is about, such as order. customer_payment for Customer Portal payment events (disputes, chargebacks, refunds and holds).

  • archiveboolean
  • created_atstring (date-time)
  • idstring

    The feed item id. Use it with the mark operations.

  • seenboolean
• statusintegerrequired
• successbooleanrequired
• paginationobject
  Child fields (6)

  • countintegerrequired
  • currentPageintegerrequired
  • linksobject | array of anyrequired

    Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.

    Child fields (2)

    • nextstring (uri)

      The next page.

    • previousstring (uri)

      The previous page.

  • perPageintegerrequired
  • totalintegerrequired
  • totalPagesintegerrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  not_seen_yet or show_archive is not 0 or 1 (validation_failed; error.fields names the field).

  Fix

  Send 1 or 0.

Related

• PUTMark notifications as seen/v1/api/store/{team_slug}/current_user_feed/seen
• PUTMark all your notifications as seen/v1/api/store/{team_slug}/current_user_feed/mark_all_as_seen
• PUTArchive notifications/v1/api/store/{team_slug}/current_user_feed/archive

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/current_user_feed' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "activity": {
        "action": "new_comment",
        "created_at": "2026-11-03T09:30:00+00:00",
        "id": "r5rAJkp7z5ZNZI",
        "message_key": "order.new_comment",
        "object": {
          "comment": {
            "comment": "Customer approved the blue ink.",
            "id": "JiDNJJ08el0QrD"
          },
          "order": {
            "id": "V4keXwwxMQyXw7",
            "object_type": "sales_order",
            "quote": false,
            "scoped_id": "SO1001"
          },
          "team": {
            "id": "1ulms05RCQN3k2",
            "name": "Example Print Shop"
          },
          "user": {
            "avatar_url": "https://example.com/avatar.png",
            "id": "VG7s3tFzyQbO2N",
            "name": "Alex Rivera"
          }
        },
        "team": {
          "id": "OwgPxM73OKqou3",
          "name": "Example Print Shop",
          "slug": "your-team"
        },
        "type": "order"
      },
      "archive": false,
      "created_at": "2026-11-03T09:30:00+00:00",
      "id": "H3w5wUZaIrCb52",
      "seen": false
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}