Skip to main content
GET
List the signed-in supplier’s alerts

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Authorization
string
header
required

The signed-in person's Cognito access token, issued to this application's app client. Sent with the API key on the /clients/me and /suppliers/me routes.

Path Parameters

projectId
string
required

The project (tenant) that owns the resource. Every resource in this API is scoped to a project, and your API key is restricted to the projects it was issued for — a project outside that scope returns 403.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

Query Parameters

filter
enum<string>
default:all

unread for the unread alerts only; all (the default) for every alert.

Available options:
unread,
all
Example:

"unread"

limit
integer

Maximum alerts to return in data, 1–100. Defaults to 20. Values outside the range return 400. Treat nextCursor: null as the only end-of-results signal.

Required range: 1 <= x <= 100
Example:

20

cursor
string

Opaque token from a previous response’s nextCursor. Valid only for the same filter that produced it; any other cursor is 400 INVALID_CURSOR — request the first page again without it.

Minimum string length: 1
Example:

"eyJwayI6InByal8wMSJ9"

Response

A page of alerts

data
object[]
required
nextCursor
string | null
required

Cursor for the next page; null on the last page.

Example:

null