List Members
Required scope: `households:read` (personal access tokens; sessions have every scope).
Required scope: households:read (personal access tokens; sessions have every scope).
Authorization
bearerAuth Authorization: Bearer <token>: a mobile session token, or a personal access token
(srp_…) created in Account → API tokens (DEV-1).
Personal access tokens:
- Act as their user. The household comes from
X-SpendRock-Household, else the user's default. - Carry scopes (DEV-2), and each operation's description names the one it needs:
budget:read/budget:write(months, groups, items, funds, favorites, harvest),transactions:read/transactions:write(transactions, merchant suggestions),households:read/households:manage(households, members, invites),account:read/account:write(me, settings). A write scope includes its read scope. A call outside the token's scopes gets 403insufficient_scope, with the needed scope indetails.required_scope. - Can't manage tokens or passwords (403
session_required). - May expire (401
unauthenticatedafterwards). - Are rate-limited (DEV-3): 120 requests/minute per token with bursts up to 120. Every
response carries
X-RateLimit-Limit,X-RateLimit-Remaining, andX-RateLimit-Reset(seconds until the bucket is full again); over the limit the answer is 429rate_limitedwithRetry-After(seconds). Limits are kept per server instance, so they're approximate.
Sessions (web cookie or mobile bearer) have every scope and aren't limited this way. Cross-origin browser calls (CORS, for the API docs playground) must use a bearer token; cookies are never accepted cross-origin.
In: header
Path Parameters
ULID.
^[0-9A-HJKMNP-TV-Z]{26}$Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/households/01J8Z3N4Q5R6S7T8V9W0X1Y2Z3/members"{ "members": [ { "user_id": "string", "name": "string", "first_name": "string", "email": "string", "role": "owner", "joined_at": "2019-08-24T14:15:22Z" } ]}Make another member the owner (owner only, HH-2). Not for personal households. POST
Required scope: `households:manage` (personal access tokens; sessions have every scope).
Remove a member (owner only, HH-2). They lose access on their next request (HH-16). DELETE
Required scope: `households:manage` (personal access tokens; sessions have every scope).