Quickstart

1. Create a key

Open Create API key in the dashboard. Give the key a name so you can recognise this integration later.

Set Members to Read. Leave the other resources at None, then create the key. Copy the revealed token into your server’s secret storage; the dashboard cannot retrieve the plaintext token later.

2. Make a request

Set the environment variable FLORALITY_KEY to your copied key using your terminal or deployment secret settings. Then run either example. No member ID or existing member is required.

curl --fail-with-body --include \
  'https://floralitys.com/api/v1/members/page?limit=10' \
  --header "Authorization: Bearer $FLORALITY_KEY"

3. Read the response

A successful request returns HTTP 200. An empty roster is also a successful result:

{
  "items": [],
  "nextCursor": null,
  "total": 0
}

items contains the members in the selected system scope. Without explicit system parameters, the route uses the account’s active scope. total counts matching members; when nextCursor is an object, send its index as the next request’s cursor. Stop when it is null.

A 401 means the key is missing or invalid. A 403 can mean that Members read access is missing. See Authentication and Errors.

Next steps

Use the paginated members reference for filters and fields. Review Scopes before enabling writes, and Privacy buckets before reading a friend’s resources.

For account exports, open Export in the dashboard. Account plan data remains in the billing reference.