Skip to main content
GET
/
Customers
GET /Customers
curl --request GET \
  --url https://{base_url}/Customers \
  --header 'X-API-KEY: <x-api-key>'
Retrieve a paginated list of customer records. Use filters to narrow results by ID or last-modified date range.
​
X-API-KEY
string
required
Your API key
​
CustomerId
string
Filter to a specific customer by ID
​
DateUpdatedStart
string
Filter by last modified date (start). Format: yyyy-MM-ddTHH:mm:ss.fffZ
​
DateUpdatedEnd
string
Filter by last modified date (end). Format: yyyy-MM-ddTHH:mm:ss.fffZ
​
Sort
string
Sort order: asc or desc
​
Limit
integer
Number of records to return
​
StartIndex
integer
Zero-based offset for pagination
curl --location '[BASE_URL]/Customers?Limit=20&StartIndex=0' \
--header 'X-API-KEY: your_api_key_here'
Response is a paginated result with from, to, length, and items (array of CustomerSearchResult). CustomerSearchResult fields
FieldTypeDescription
idstringNowBookIt customer ID
firstNamestringFirst name
lastNamestringLast name
fullNamestringFull name
emailstringEmail address
phonestringPhone in international format
phoneNationalstringPhone in national format
phone2stringSecondary phone
birthdayDateintegerDay of birth (1–31)
birthdayMonthintegerMonth of birth (1–12)
birthdayYearintegerYear of birth
companystringCompany name
addressobjectline1, line2, city, state, postalCode, country
notesstringInternal notes
noShowCountintegerNumber of no-shows
tagsarrayTags: [{ id, identifier, name }]
subscribedbooleanSubscribed to marketing emails
lastModifiedDatestringUTC datetime of last update
Example 200 Response 
{
  "from": 0,
  "to": 1,
  "length": 1,
  "items": [
    {
      "id": "cust-abc123",
      "firstName": "Jane",
      "lastName": "Smith",
      "fullName": "Jane Smith",
      "email": "jane.smith@example.com",
      "phone": "+61412345678",
      "phoneNational": "0412345678",
      "birthdayDate": 15,
      "birthdayMonth": 6,
      "birthdayYear": 1985,
      "address": {
        "line1": "123 Main St",
        "city": "Sydney",
        "state": "NSW",
        "postalCode": "2000",
        "country": "Australia"
      },
      "notes": "Prefers window seating",
      "noShowCount": 0,
      "tags": [{ "id": "tag-1", "identifier": "vip", "name": "VIP" }],
      "subscribed": true,
      "lastModifiedDate": "2024-03-15T10:30:00Z"
    }
  ]
}
StatusDescription
200Customers returned
400loggedInAppId
400No Venue Subscribed to your App.
401X-API-KEY missing or invalid
429Rate limit exceeded
500An error occurred.