ConsoleGo to website

Flavoso APIAPI referenceConnection

Connection

The connection between your app and one restaurant. GET /me is the first call of every integration: which restaurant, which scopes, test or live (livemode), which plan. DELETE /connection ends the connection from your side.

Endpoints

Retrieve the connection, its app and its restaurant

get/me

Scope:
any valid token
Plan:
every plan

Works with any valid access token, also while the restaurant's subscription is inactive. The first call of every integration: it answers which restaurant this token belongs to, whether it is a test restaurant (livemode: false), which permissions the connection has and which plan the restaurant is on (reservations need Pro).

Response200

OK

  • objectstringrequired

    Always connection.

    Values:"connection"

  • idstring (uuid)required

    The connection, also connection_id in events.

  • livemodebooleanrequired

    false for a developer's test restaurant: no guests, no payments, no e-mails, text messages or push notifications.

  • appobjectrequired

    Your app.

    Child fields (2)
    • client_idstringrequired

      The OAuth client id.

    • namestringrequired

      The app's name.

  • tenantobjectrequired

    The restaurant this token belongs to.

    Child fields (6)
    • idstring (uuid)required

      The restaurant's id (tenant_id in events).

    • namestringrequired

      The restaurant's name.

    • slugstringrequired

      Its address: <slug>.flavoso.com.

    • timezonestringrequired

      IANA time zone, e.g. Europe/Berlin. Local dates and hours are in it.

    • currencystringrequired

      ISO 4217 currency of all amounts, e.g. EUR.

    • countrystringrequirednullable

      ISO 3166-1 alpha-2 country as Flavoso uses it for VAT (from the tax settings, else the address, else the time zone); null when unknown.

  • scopesstring[]required

    What this token may do (a narrowed token may have fewer than the connection).

    Values:"orders:read""orders:write""menu:read""menu:write""store:read""store:write""reservations:read""reservations:write""reports:read"

  • planstringrequired

    The restaurant's plan. Reservations need pro or premium; ordering at the table needs pro.

    Values:"starter""pro""premium"

  • rate_limitobjectrequired

    The rate limit of this connection.

    Child fields (2)
    • limitintegerrequired

      Requests per window.

    • window_secondsintegerrequired

      Window length in seconds.

  • created_atstring (date-time)required

    When the restaurant connected the app. ISO 8601 in UTC (Z).

Errors

  • 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
  • 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
  • 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
  • 500server_error. Safe to retry with the same Idempotency-Key.

All error codes

Request
curl "https://api.flavoso.com/v1/me" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response
{
  "object": "connection",
  "id": "c41d7e2a-9b3f-4e8c-a015-6d2f8b4e7c19",
  "livemode": true,
  "app": {
    "client_id": "flv_app_9QpR2sT4uV6wX8yZ0aB1cD3e",
    "name": "Kasse Nord"
  },
  "tenant": {
    "id": "8a3e5c7d-2f14-4b9e-a6d1-0c4b7e9f2a35",
    "name": "Trattoria Bella Rosa",
    "slug": "bella-rosa",
    "timezone": "Europe/Berlin",
    "currency": "EUR",
    "country": "DE"
  },
  "scopes": [
    "orders:write",
    "menu:write",
    "store:write"
  ],
  "plan": "pro",
  "rate_limit": {
    "limit": 120,
    "window_seconds": 60
  },
  "created_at": "2026-10-01T09:15:42.118Z"
}

Disconnect your app from the restaurant

delete/connection

Scope:
any valid token
Plan:
every plan

Ends the connection: every token of it is revoked, including the one used for this request, the restaurant's owners are notified by e-mail and your app receives app.disconnected (reason app). To use the restaurant again, the owner has to connect the app again.

Response200

OK

  • objectstringrequired

    Always connection.

    Values:"connection"

  • idstring (uuid)required

    The connection that ended.

  • revokedbooleanrequired

    Always true.

    Values:true

Errors

  • 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
  • 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
  • 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
  • 500server_error. Safe to retry with the same Idempotency-Key.

All error codes

Request
curl -X DELETE "https://api.flavoso.com/v1/connection" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response
{
  "object": "connection",
  "id": "c41d7e2a-9b3f-4e8c-a015-6d2f8b4e7c19",
  "revoked": true
}

Still unclear? Write to support@flavoso.com and include the id from X-Request-Id. It lets us find your request in the log.