List events

Cursor-paginated. Returns the same scalar shape as webhook deliveries, so a caller can handle a delivery and a list row with the same code. The heavy fields — description HTML, image URLs, links — and an event’s groups and lines are only on the get-by-id endpoint.

Newest first. Filter by status to poll just the part of the pipeline you care about, for example ?status=approved for events cleared to order against.

GET/api/v1/events

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Query parameters

fieldsstring

Comma-separated list of the fields to return, so a caller can ask for the parts of an object it actually uses. A dotted path reaches inside a collection, so `variants.sku` keeps the variants array with only each variant's SKU. The object's own id comes back whether or not it is listed, which keeps a trimmed response addressable. A name that the resource hasn't got returns 422 `unknown_fields:` followed by the names that did not resolve. Omit the parameter for the full object.

limitinteger

min 1 · max 100 · default: 25

cursorstring

statusstring

Restrict to one workflow status.

Allowed:newquotingpending_approvalapprovedin_progresscompletecancelled

Responses

200OK

itemsEventListItem[]required

Show properties

Array of EventListItem

eventIdstringrequired

slugstring | null

namestringrequired

statusEventStatus | any

Show properties

One of:

EventStatus

string

any

any

ceremonyAddressstring | null

venueAddressstring | null

ceremonyStartinteger | null

Unix ms.

ceremonyEndinteger | null

Unix ms. Null when the event has no ceremony time set.

venueStartinteger | null

Unix ms, when setup at the reception venue begins.

venueEndinteger | null

Unix ms, when the event ends at the venue.

clientName1string | null

First client on the event. Both names are free text.

clientName2string | null

Second client, for a couple. Null for a single-client event.

budgetnumber | null

The client's budget, in the tenant's currency, excluding tax. Null when none was agreed.

numberOfGuestsinteger | null

Guest count, used for planning rather than pricing.

numberOfTablesinteger | null

Table count, which table-centre quantities are usually derived from.

colourSchemestring[] | null

Colour labels for the event, matched against the colour vocabulary by label rather than by ID. See GET /api/v1/colors for the labels that will line up.

totalsobject | null

The event's stored rollup, or `null` when the request asked for no money fields (`?fields=` without `totals`).

Show properties

customerPriceIncTaxnumberrequired

What the customer pays for the whole event: every visible line with tax and markup, plus labour, additional fees and travel. Larger than the sum of the line prices for that reason.

costIncTaxnumberrequired

What the units the design consumes cost, including tax, before markup. Excludes the pack leftovers.

wasteCostIncTaxnumberrequired

What the pack leftovers cost, including tax, before markup. Computed per line, so it can differ slightly from the event page's Waste card, which pools packs across lines sharing a variant.

costOfGoodsIncTaxnumberrequired

What the florist actually pays out: costIncTax plus wasteCostIncTax. A breakdown of this figure, not an extra beside it, so never add all three together.

itemsCountintegerrequired

Lines on the event, hidden groups included.

isDonebooleanrequired

cursorstring | nullrequired

401Missing or invalid API key, or revoked / expired.

errorstringrequired

403Authenticated, but the key lacks the required scope or the tenant has no API access.

errorstringrequired

422Request body or arguments failed validation.

errorstringrequired

429Per-minute rate limit (60/min) or per-month cap exceeded.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (bloomcount_...)Remember on this deviceInclude my values in samples

Parameters

fieldsqueryComma-separated list of the fields to return, so a caller can ask for the parts of an object it actually uses. A dotted path reaches inside a collection, so `variants.sku` keeps the variants array with only each variant's SKU. The object's own id comes back whether or not it is listed, which keeps a trimmed response addressable. A name that the resource hasn't got returns 422 `unknown_fields:` followed by the names that did not resolve. Omit the parameter for the full object.limitquerycursorquerystatusqueryRestrict to one workflow status.

Request

curl -X GET "https://app.bloomcount.com/api/v1/events" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://app.bloomcount.com/api/v1/events", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://app.bloomcount.com/api/v1/events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "items": [
    {
      "eventId": "evt_2b1f3x9k4m7p8q6r5t1v0w2y",
      "name": "Lewis & Sam Wedding",
      "slug": "lewis-sam-wedding",
      "status": "quoting",
      "clientName1": "Lewis",
      "clientName2": "Sam",
      "ceremonyStart": 1810800000000,
      "ceremonyEnd": 1810824000000,
      "budget": 8000,
      "numberOfGuests": 80
    }
  ],
  "isDone": false,
  "cursor": "eyJpZCI6ImV2dF8yYjFmM3g5azRt"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}