List venues

Cursor-paginated. An event references a venue by ID, so this is how an integration resolves one before writing events.

distanceMeters and durationSeconds are computed in the background from your own business address, so a venue created a moment ago may read null on both until that finishes. Poll the venue again rather than treating null as “no route”.

GET/api/v1/venues

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.

cursorstring

limitinteger

min 1 · max 100 · default: 25

Responses

200OK

itemsVenue[]required

Show properties

Array of Venue

venueIdstringrequired

namestringrequired

What the venue is called. This is what an event shows.

addressstring | null

Full postal address. What the driving distance is measured to, so a venue without one has no distance.

googleMapsUrlstring | null

A maps link for whoever is driving. Not used for routing.

phonestring | null

The venue's main number.

websitestring | null

The venue's website.

contactNamestring | null

Who to speak to at the venue.

contactEmailstring | null

Email for that contact.

contactPhonestring | null

Direct number for that contact

notesstring | null

Free text — access

entryStartstring | null

Earliest time the venue allows access, as free text.

entryEndstring | null

Latest time the venue allows access, as free text.

distanceMetersinteger | null

Driving distance from your business address. Null until the background lookup has run, or when either address is missing.

durationSecondsinteger | null

Driving time from your business address, on the same terms as distanceMeters.

isDonebooleanrequired

cursorstring | null

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

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.cursorquerylimitquery

Request

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

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

import requests

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

Response

{
  "items": [
    {
      "venueId": "ven_k2m7p4r9t3v6x1z8b5n0q7w4",
      "name": "The Manor Barn",
      "address": "The Manor Barn, Bath BA1 5TQ",
      "distanceMeters": 18400,
      "durationSeconds": 1620
    },
    {
      "venueId": "ven_l3n8q5s0u4w7y2a9c6o1r8x5",
      "name": "Wells Assembly Rooms",
      "address": null,
      "distanceMeters": null,
      "durationSeconds": null
    }
  ],
  "isDone": true,
  "cursor": null
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}