List staff

Cursor-paginated. These are the people who can be assigned to an event as lead or support.

hasAccount marks a row that belongs to a signed-in member of the organisation. Those rows are maintained from the account and can’t be deleted here.

GET/api/v1/staff

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

itemsStaffMember[]required

Show properties

Array of StaffMember

staffIdstringrequired

namestringrequired

hourlyRatenumber | null

mileageRatenumber | null

addressstring | null

emailstring | null

phonestring | null

companyNamestring | null

websitestring | null

hasAccountbooleanrequired

True when this row belongs to a signed-in member. Those rows can't be deleted over the API.

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/staff" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

import requests

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

Response

{
  "items": [
    {
      "staffId": "stf_r4t7v2x9z1b6n3q8w5y0m2k7",
      "name": "Priya Raman",
      "hourlyRate": 22.5,
      "mileageRate": 0.45,
      "email": "priya@example.com",
      "hasAccount": false
    },
    {
      "staffId": "stf_s5u8w3y0a2c7e4g9i6k1m8o5",
      "name": "Sam Oduya",
      "hourlyRate": 25,
      "mileageRate": null,
      "email": null,
      "hasAccount": true
    }
  ],
  "isDone": true,
  "cursor": null
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}