> ## Documentation Index > Fetch the complete documentation index at: https://restoo.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get Tenant Profile > Returns the public tenant profile and configuration needed by booking-channel integrations. ## OpenAPI ````yaml /public-api.json get /tenant/profile openapi: 3.1.0 info: title: Restoo Public API version: 3.0.0-alpha description: Connect your App with Restoo. servers: - url: https://api-dev.myrestoo.net/v3 description: Dev - url: https://api.myrestoo.net/v3 description: Prod security: - http: [] tags: - name: Review paths: /tenant/profile: get: tags: - Tenant summary: Get Tenant Profile description: >- Returns the public tenant profile and configuration needed by booking-channel integrations. operationId: tenant.showProfile parameters: - name: Restoo-Partner-Id in: header required: true description: Unique identifier of your Partner account (defined by Restoo). schema: type: string example: your-restoo-partner-id - name: Restoo-Account-Id in: header required: true description: >- Unique identifier of the [Tenant](/getting-started/key-concepts#tenant). schema: type: string example: best-burger responses: '200': description: '`TenantProfileResponse`' content: application/json: schema: $ref: '#/components/schemas/TenantProfileResponse' '409': $ref: '#/components/responses/TenantNotFoundException' components: schemas: TenantProfileResponse: type: object properties: isStandBy: type: boolean description: >- Whether the venue's subscription is paused. While it is, the venue takes no Bookings, `features` comes back `null` and `reopenDate` may say when it returns default: false reopenDate: type: - string - 'null' description: >- When a paused venue is expected to come back. Not every venue sets one, so this can be `null` even while `isStandBy` is `true` business: $ref: '#/components/schemas/TenantBusiness' settings: $ref: '#/components/schemas/TenantSettings' features: anyOf: - $ref: '#/components/schemas/TenantFeatures' description: >- The venue features an integration can act on. `null` while `isStandBy` is `true` - type: 'null' accountId: type: string description: The unique Restoo Account identifier for the Tenant examples: - best-burger required: - isStandBy - reopenDate - business - settings - features - accountId title: TenantProfileResponse TenantBusiness: type: object description: Represents the public business information of a Tenant. properties: name: type: string description: |- The business name of the venue. This is the public commercial name displayed to customers examples: - Best Burger phone: type: - string - 'null' description: |- The business phone number in E.164 format. If `null`, the venue does not provide a contact phone examples: - '+34910011223' whatsapp: type: - string - 'null' description: |- The business WhatsApp contact number in E.164 format. If `null`, the venue does not provide a WhatsApp contact examples: - '+34910011223' email: type: - string - 'null' format: email description: |- The general contact email of the venue. If `null`, no public email is available examples: - contact@bestburger.com websiteUrl: type: - string - 'null' format: uri description: The official website URL of the venue examples: - https://bestburger.com bookingsUrl: type: string format: uri description: The URL pointing to the venue's bookings' widget examples: - https://best-burger.myrestoo.net menuUrl: type: - string - 'null' format: uri description: |- The URL pointing to the venue's menu. May reference a PDF or a dedicated menu web page examples: - https://bestburger.com/menu groupMenuUrl: type: - string - 'null' format: uri description: |- The URL pointing to the group or corporate menu. Used by venues that offer special menus for groups or events examples: - https://bestburger.com/group-menu parkingUrl: type: - string - 'null' format: uri description: >- A URL containing parking directions or parking information for the venue examples: - https://bestburger.com/parking address: $ref: '#/components/schemas/Address' description: The complete physical address of the venue required: - name - phone - whatsapp - email - websiteUrl - bookingsUrl - menuUrl - groupMenuUrl - parkingUrl - address title: TenantBusiness TenantSettings: type: object properties: book: $ref: '#/components/schemas/BookSettings' regional: $ref: '#/components/schemas/RegionalSettings' communication: $ref: '#/components/schemas/CommunicationSettings' required: - book - regional - communication title: TenantSettings TenantFeatures: type: object description: >- The venue features an integration can act on. Restoo has many more internally; this is the subset that changes what you may send or offer. properties: allowExternalBookingUpdates: $ref: '#/components/schemas/Feature' description: >- Whether the venue accepts Bookings being modified from outside Restoo. Cancelling is exempt and works either way hotels: $ref: '#/components/schemas/Feature' description: >- Whether the venue takes hotel guests. Sending `hotelRoom` on a Booking while it is disabled answers HTTP 403 differentiateChildren: $ref: '#/components/schemas/DifferentiateChildrenFeature' description: >- Whether `paxChildren` is counted separately from `pax`. While it is disabled, children sent on a Booking are added to the PAX count instead bookingAllergiesRequired: $ref: '#/components/schemas/Feature' description: >- Whether `allergiesDescription` becomes mandatory once `hasAllergies` is `true` customerSpecialRequests: $ref: '#/components/schemas/CustomerSpecialRequestsFeature' description: >- Which special requests the venue accepts on a Booking. Each `allow…` sub-flag gates its own field bookingCustomerZipCodeRequest: $ref: '#/components/schemas/Feature' description: Whether the Customer's `postalCode` can be sent bookingCustomerBirthDateRequest: $ref: '#/components/schemas/BookingCustomerBirthDateRequestFeature' description: >- Whether the Customer's `birthDate` can be sent, and whether `mode` makes it optional or required marketingAnnouncements: $ref: '#/components/schemas/Feature' description: >- Governs Restoo's announcements endpoints, which are not part of this API groupDirectory: $ref: '#/components/schemas/Feature' description: >- Whether the account this venue belongs to has more than one location, and so publishes a locations directory required: - allowExternalBookingUpdates - hotels - differentiateChildren - bookingAllergiesRequired - customerSpecialRequests - bookingCustomerZipCodeRequest - bookingCustomerBirthDateRequest - marketingAnnouncements - groupDirectory title: TenantFeatures Address: type: object description: The postal address details. properties: line1: type: string description: The first line of the street address examples: - Infinite Loop 1 maxLength: 255 line2: type: - string - 'null' description: |- Additional address information, if applicable. Commonly used for apartment numbers, building names, floors, or any optional extra details examples: - Apt. 4B maxLength: 255 location: type: - string - 'null' description: |- The commercial or business complex where the venue is located. Used to specify contextual location details such as: - Shopping malls - Business centers - Corporate campuses - Industrial parks This field is optional and appears only when relevant examples: - Apple Campus maxLength: 255 city: type: string description: The city or locality of the address examples: - Cupertino maxLength: 100 state: type: string description: The state, province, or region of the address examples: - California maxLength: 100 postalCode: type: string description: The postal or ZIP code corresponding to the address examples: - '95014' maxLength: 12 country: $ref: '#/components/schemas/CountryEnum' description: The country represented as a two-letter ISO 3166-1 alpha-2 code examples: - ES required: - line1 - line2 - location - city - state - postalCode - country title: Address BookSettings: type: object properties: punctualityCourtesyMinutes: type: integer maxAdvanceBookingDays: type: integer maxBookingSize: type: - integer - 'null' required: - punctualityCourtesyMinutes - maxAdvanceBookingDays - maxBookingSize title: BookSettings RegionalSettings: type: object properties: timeZone: type: string regionalCustomerPreferredLang: $ref: '#/components/schemas/CustomerLanguageEnum' preferredLang: $ref: '#/components/schemas/CustomerLanguageEnum' taxRate: type: integer taxName: type: string currency: $ref: '#/components/schemas/CurrencyEnum' description: The currency represented as a three-letter ISO 4217 code examples: - EUR required: - timeZone - regionalCustomerPreferredLang - preferredLang - taxRate - taxName - currency title: RegionalSettings CommunicationSettings: type: object properties: tone: $ref: '#/components/schemas/CommunicationToneEnum' required: - tone title: CommunicationSettings Feature: type: object properties: isEnabled: type: boolean description: >- Whether the venue has the feature switched on. A feature its plan does not include cannot be switched on, so this is `false` in that case too required: - isEnabled title: Feature DifferentiateChildrenFeature: type: object properties: childrenAreUnderYears: type: - integer - 'null' isEnabled: type: boolean description: >- Whether the venue has the feature switched on. A feature its plan does not include cannot be switched on, so this is `false` in that case too required: - childrenAreUnderYears - isEnabled title: DifferentiateChildrenFeature CustomerSpecialRequestsFeature: type: object properties: allowChildrenRequests: type: boolean allowAllergiesRequest: type: boolean allowSpecialOccasionRequest: type: boolean allowAccessibleRequest: type: boolean allowOtherSpecialRequests: type: boolean isEnabled: type: boolean description: >- Whether the venue has the feature switched on. A feature its plan does not include cannot be switched on, so this is `false` in that case too required: - allowChildrenRequests - allowAllergiesRequest - allowSpecialOccasionRequest - allowAccessibleRequest - allowOtherSpecialRequests - isEnabled title: CustomerSpecialRequestsFeature BookingCustomerBirthDateRequestFeature: type: object properties: mode: anyOf: - $ref: '#/components/schemas/CustomerBirthDateRequestModeEnum' - type: 'null' isEnabled: type: boolean description: >- Whether the venue has the feature switched on. A feature its plan does not include cannot be switched on, so this is `false` in that case too required: - mode - isEnabled title: BookingCustomerBirthDateRequestFeature CountryEnum: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CV - KH - CM - CA - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MK - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - UM - US - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW title: CountryEnum CustomerLanguageEnum: type: string enum: - es - ca - it - en - de - fr - pt - eu title: CustomerLanguageEnum CurrencyEnum: type: string enum: - EUR - USD - GBP - MXN - DOP title: CurrencyEnum CommunicationToneEnum: type: string enum: - INFORMAL - FORMAL title: CommunicationToneEnum CustomerBirthDateRequestModeEnum: type: string enum: - OPTIONAL - REQUIRED - NONE title: CustomerBirthDateRequestModeEnum responses: TenantNotFoundException: description: >- Business Logic Error — The request is syntactically correct but cannot be processed due to logical constraints. Example: attempting to create a booking on a closed day or outside the allowed hours. content: application/problem+json: schema: type: object properties: type: type: string description: A URI identifier that categorizes the error type. examples: - about:blank title: type: string description: A short, human-readable summary of the problem type. examples: - Conflict status: type: integer description: >- The HTTP status code generated by the origin server for this occurrence of the problem. examples: - 409 code: type: string description: >- A short string indicating the error code that could be handled programmatically. examples: - BOOKING_IS_NOT_ON_SEATED_GROUP detail: type: string description: >- A human-readable message providing more details about the error. examples: - The booking must be on the seated group status to be ended. required: - type - title - status - code - detail securitySchemes: http: type: http description: >- All requests must include the static API Key in the Authorization header using the Bearer scheme. scheme: bearer ````