• VillaSlotDocumentation
  • Introduction
  • Getting Started
  • API
    • Discovery
      • GETGet my context
    • Villas
      • GETList villas
      • POSTCreate a villa
      • GETGet a villa
      • PATCHRename a villa
      • POSTArchive a villa
      • POSTUpload a villa photo
      • GETGet opening hours
      • PUTReplace opening hours
      • GETGet the rate grid
      • PUTReplace the rate grid
      • GETGet availability
    • Bookings
      • GETList bookings over a period
      • POSTCreate a booking
      • GETGet a booking
      • POSTConfirm a booking
      • POSTComplete a booking
      • POSTCancel a booking
      • POSTReschedule a booking
    • Customers
      • GETList customers
      • POSTCreate a customer
      • POSTImport a batch of customers
      • GETGet a customer
      • PATCHUpdate a customer
    • Booking settings
      • GETGet booking settings
      • PATCHUpdate booking settings
  1. Documentation
  2. API
  3. Customers
  4. List customers
Buydocschangelogsdemocommunity

List customers

PreviousCustomersNextCreate a customer
On this page
AuthorizationQuery parametersExampleResponseWhat it refuses

GET /api/v1/customers

The address book of the key's organization.

Authorization

Role in the organizationThis endpoint
ownerAllowed
adminAllowed
memberAllowed

Query parameters

ParameterTypeDefaultDescription
pageinteger1Page number, from 1
limitinteger20Page size, capped at 100
searchstring—Matches name, email and phone at once

Example

bash
curl -H "x-api-key: $VILLASLOT_API_KEY" \
  "https://villaslot.app/api/v1/customers?search=lindqvist"

Response

  • 200 OK — the page, with pagination.

What it refuses

  • 401 Unauthorized — missing or invalid key, or a key whose bearer left the organization.
  • 404 Not Found — unknown id, or an id belonging to another organization. The two are deliberately indistinguishable.
  • 429 Too Many Requests — over 120 requests in a minute for this key.