Menu

API Documentation

Structured docs for the concierge integration API.

Authentication

API access is private and requires approved credentials. Admin API keys unlock expanded concierge fields on /api/concierges endpoints.

Request API Access

Public access is disabled for now. Contact us to request credentials.

Email contact@airconcierge.io

Endpoints

GET/api

Localized docs in browser, JSON index with ?format=json.

Private access required.

Parameters

  • format=json (optional, force JSON index payload)

Response Shape

Docs redirect (browser) or JSON index response.

GET/api/concierges

Search and paginate concierge records.

Private access required.

Parameters

  • q, location, services
  • limit (max 50), offset
  • lang (en | fr)
  • view=admin (optional, requires admin API key)

Response Shape

List response with data[], pagination, language. Admin key + view=admin returns full concierge fields.

GET/api/concierges/{id}

Fetch one concierge by MongoDB ObjectId.

Private access required.

Parameters

  • id (path)
  • lang (en | fr)
  • view=admin (optional, requires admin API key)

Response Shape

Single record response with data, language. Admin key + view=admin returns full concierge fields.

OpenAPI

Machine-readable OpenAPI 3.1 specification for approved partners.

Open OpenAPI endpoint

Response Shape

{
  "data": [
    {
      "id": "65a12bc34de56f7890abc123",
      "businessName": "Example Concierge",
      "location": ["Paris"],
      "services": ["Check-in", "Cleaning"],
      "website": "https://example.com",
      "description": "Short public profile",
      "rating": 4.9,
      "reviewCount": 84,
      "commissionRateMin": 18,
      "commissionRateMax": 24
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "returned": 1,
    "total": 1,
    "hasMore": false
  },
  "language": "en"
}