Get a staff member

One person, in the same shape the list returns.

Errors

404 staff_not_found — unknown ID, or one belonging to another tenant.
422 wrong_id_type:expected_staff_got_<table> — the prefix isn’t stf_.

GET/api/v1/staff/{id}

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Path parameters

idstringrequired

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.

Responses

200OK

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.

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

404The requested resource doesn't exist or belongs to a different tenant.

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.idpath*

Request

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

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

import requests

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

Response

{
  "staffId": "stf_r4t7v2x9z1b6n3q8w5y0m2k7",
  "name": "Priya Raman",
  "hourlyRate": 22.5,
  "mileageRate": 0.45,
  "address": null,
  "email": "priya@example.com",
  "phone": null,
  "companyName": null,
  "website": null,
  "hasAccount": false
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}