Skip to main content
Flynet exposes restaurants, locations, member context, check-ins, and payment intents through stable resource shapes.

Resources

Resourceobject valueNotes
RestaurantrestaurantBrand-level restaurant entity. Fetchable via /restaurants.
LocationlocationPhysical venue that belongs to a restaurant. Embeds restaurant + neighborhood.
NeighborhoodneighborhoodGeographic grouping. Only appears embedded inside a Location, not fetchable directly.
Check-incheck_inVisit 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.
MemberuserThe authenticated member’s profile. Fetchable via /users/me.
Member statususer_statusMember standing / tier context. Fetchable via /users/me/status.
Walletuser_walletMember wallet, either MEMBERSHIP or SPENDING. Auto-provisioned on first OAuth completion. Fetchable via /users/me/wallets.
Taguser_tagMember metadata. Lowercase type values; industry identifies restaurant employees. Fetchable via /users/me/tags.
MembershipmembershipMember-to-restaurant membership record. Fetchable via /memberships.
PaymentIntentpayment_intentPayment 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.
Member-context resources live under /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 (one MEMBERSHIP, 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 an asset object with image variants:
{
  "asset": {
    "preview_1x": "https://...",
    "web_2x": "https://...",
    "full_3x": "https://..."
  }
}
The entire 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 assets
  • SPENDING - FLY available for transactions

Tags

Tags attach structured metadata to a member. The current public tag type is lowercase industry.
{
  "object": "user_tag",
  "type": "industry",
  "metadata": [
    { "key": "Employer", "value": ["FLYBAR"] }
  ]
}

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.