List customers
GET /api/v1/customers
The address book of the key's organization.
Authorization
| Role in the organization | This endpoint |
|---|---|
owner | Allowed |
admin | Allowed |
member | Allowed |
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number, from 1 |
limit | integer | 20 | Page size, capped at 100 |
search | string | — | 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, withpagination.
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.