Resources
| Resource | object value | Notes |
|---|---|---|
| Restaurant | restaurant | Brand-level restaurant entity. Fetchable via /restaurants. |
| Location | location | Physical venue that belongs to a restaurant. Embeds restaurant + neighborhood. |
| Neighborhood | neighborhood | Geographic grouping. Only appears embedded inside a Location, not fetchable directly. |
| Check-in | check_in | Visit record linking a member to a location. Embeds the full location (with restaurant + neighborhood). No user data — partners cannot enumerate Blackbird’s user base via /check_ins. |
| Member | user | The authenticated member’s profile. Fetchable via /users/me. |
| Member status | user_status | Member standing / tier context. Fetchable via /users/me/status. |
| Wallet | user_wallet | Member wallet, either MEMBERSHIP or SPENDING. Auto-provisioned on first OAuth completion. Fetchable via /users/me/wallets. |
| Tag | user_tag | Member metadata. Lowercase type values; industry identifies restaurant employees. Fetchable via /users/me/tags. |
| Membership | membership | Member-to-restaurant membership record. Fetchable via /memberships. |
| PaymentIntent | payment_intent | Payment from member to merchant in FLY. Fetchable via /payment_intents. |
| Account Balance | (internal) | FLY-denominated balance referenced by payer_account_balance_id / payee_account_balance_id on PaymentIntents. Not fetchable as a resource at launch; surfaces only as foreign-key fields on PaymentIntent. |
/users/me/*: the subject is resolved from your OAuth access token’s sub claim, so no UUID appears in the path. Routes: /users/me, /users/me/status, /users/me/wallets, /users/me/tags, /users/me/check_ins. Decode the sub claim yourself only if you need the member’s UUID for your own state.
Relationships
A typical member has two wallets (oneMEMBERSHIP, one SPENDING), zero or more tags, zero or more check-ins, a status record, zero or more memberships, and account balances that fund Payment Intents.
Restaurant assets
Restaurants include anasset object with image variants:
asset object may be null. Individual variants may
also be null.
Wallets
Wallets are created automatically on the member’s first OAuth completion. A member usually has:MEMBERSHIP- member status assetsSPENDING- FLY available for transactions
Tags
Tags attach structured metadata to a member. The current public tag type is lowercaseindustry.
Member status
/users/me/status returns the authenticated member’s standing.
If no active status exists for the member, the route returns
404 with a resource_not_found body rather than an empty
object: branch on the status code, not on an empty payload.
Memberships
/memberships returns the authenticated member’s membership
records; each links a member to a restaurant. The collection is
paginated like every other list route. It accepts a restaurant
filter; an unrecognized filter param (such as restaurant_id) is
silently ignored and returns the unfiltered set.
Reservations
Locations carry reservation-related fields describing whether and how a venue takes bookings. These surface as fields on the Location object returned by/locations*; see the
API reference for the per-field
shapes. There is no standalone reservation resource at launch.
Money
Payment amounts use{ value, currency }, where value is a
stringified integer in FLY wei. See Money + tokens.