> ## Documentation Index
> Fetch the complete documentation index at: https://docs.obvlo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Obvlo REST API for search, discovery, host bootstrap, and language configuration.

The Obvlo API reference covers the stable content endpoints.

## Base URL

```text Base URL theme={null}
https://api.obvlo.com
```

## Authentication

All requests require a valid `key` query parameter. Public endpoints use `orgId` as a path parameter in the URL, for example `/v2/orgs/{orgId}/guide-search`. Some endpoints also accept a `profileId` query parameter to scope results to a specific host profile. Contact [support@obvlo.com](mailto:support@obvlo.com) to obtain your credentials.

## Endpoints

<CardGroup cols={2}>
  <Card title="Guide Search" icon="map" href="/api-reference/endpoint/guide-search">
    `GET /v2/orgs/{orgId}/guide-search` — Search curated travel guides.
  </Card>

  <Card title="Listing Search" icon="location-dot" href="/api-reference/endpoint/listing-search">
    `GET /v2/orgs/{orgId}/listing-search` — Search individual listings.
  </Card>

  <Card title="Location Search" icon="map-pin" href="/api-reference/endpoint/location-search">
    `GET /v2/orgs/{orgId}/location-search` — Search neighbourhoods and areas.
  </Card>

  <Card title="Host Profile" icon="house" href="/api-reference/endpoint/host-profile">
    `GET /v2/orgs/{orgId}/host-profile` — Retrieve branding and configuration for a host property.
  </Card>

  <Card title="Host Home" icon="house-chimney" href="/api-reference/endpoint/host-home">
    `GET /v2/orgs/{orgId}/host-home` — Bootstrap a host home screen in a single request.
  </Card>

  <Card title="Organisation Languages" icon="language" href="/api-reference/endpoint/org-languages">
    `GET /v2/orgs/{orgId}/org-languages` — Retrieve supported languages for an organisation.
  </Card>
</CardGroup>

## Pagination

All search endpoints return paginated results. Use `page` (1-based) and `hitsPerPage` (max 20) to navigate pages. The response always includes `total` (total matching records) and `pages` (total page count).

## Localisation

Search and discovery endpoints can return localised fields in two shapes. When `lang` is omitted, localised fields are returned as objects keyed by BCP 47 language code, for example `{ "en-GB": "Top Restaurants" }`. When `lang` is provided, the same fields are returned as resolved values for that language. This applies to guide, listing, location, and host-home responses.

Preview endpoints are documented separately under the `Preview` section.