The Basic Details endpoint provides essential venue information and images. This is perfect for search result previews, venue lists, and any application where you need quick venue information without the overhead of complete profiles.

Endpoint

GET /v1/establishments/basic/{venueId}

Caching

If you are caching the venue details, you should only cache the venue ID. Do not cache the full venue details response, as the data changes frequently and must always be fetched fresh for accuracy and compliance.

Parameters

id (required)

The venue ID obtained from search results or other InBe endpoints.

Response structure

Basic details response

type BasicDetails = {
  id: string;
  name: string;
  displayName: string;
  formattedAddress: string;
  location: {
    type: string;
    coordinates: [number, number];
  };
  websiteUri: string;
  contactEmail: string;
  contactNumber: string;
  description: string;
  primaryGenre: string;
  additionalGenres: string[];
  wordOnTheStreet: string;
  isChain: boolean;
  regularOpeningHours: {
    days: string[];
    timeSlots: {
      open: string;
      close: string;
      isClosed: boolean;
      closeNextDay: boolean;
    }[];
  }[];
  mainImageUrl: string;
  logo: string;
  establishmentFlags: string[];
  catersFlags: string[];
  photos: {
    url: string;
    caption: string | null;
  }[];
  avgPPH: string;
  specialOpeningHours: {
    date: string;
    timeSlots: {
      open: string;
      close: string;
      isClosed: boolean;
      closeNextDay: boolean;
    }[];
  }[];
  kitchenOpenTimes: {
    days: string[];
    timeSlots: {
      open: string;
      close: string;
      isClosed: boolean;
      closeNextDay: boolean;
    }[];
  }[];
  bookingUrl: {
    url: string;
    provider: string;
  };
  ratings: {
    rating: string;
    userRatingCount: number;
  };
  accessibility: {
    entrance: boolean;
    parking: boolean;
    bathroom: boolean;
    seating: boolean;
  };
  payment: {
    credit: boolean;
    debit: boolean;
    cash: boolean;
    nfc: boolean;
    online: boolean;
    amex: boolean;
    amexFee: boolean;
    exclAmex: boolean;
  };
  parking: {
    street: boolean;
    garage: boolean;
    lot: boolean;
    valet: boolean;
  };
};

Use cases

Search result previews
Venue list items
Quick venue information
Performance-critical applications

Real-world examples

TypeScript

async function displaySearchResults(searchResults: SearchResult[]) {
  const venueCards = await Promise.all(
    searchResults.map(async (result) => {
      const basicDetails = await fetch(
        `/v1/establishments/basic/${result.id}`,
        {
          headers: { "Api-Key": `${process.env.API_KEY}` },
        },
      ).then((res) => res.json());
 
      return createVenueCard(basicDetails);
    }),
  );
 
  return venueCards;
}