Skip to main content
GET
List Bookings

Description

This endpoint allows you to retrieve a list of all bookings in your LatePoint system. It includes advanced filtering, search, and pagination options to efficiently handle large volumes of data.

Authentication

string
required
Your LatePoint API key. You can get it from the admin panel.

Query Parameters

Pagination

integer
default:"1"
Page number for pagination
integer
default:"20"
Number of bookings per page (max 100)

Basic Filters

string
Filter by booking status (pending, confirmed, cancelled, completed)
integer
Filter by customer ID
integer
Filter by agent ID
integer
Filter by service ID
integer
Filter by location ID

Date Filters

string
Filter bookings from this date (YYYY-MM-DD format)
string
Filter bookings until this date (YYYY-MM-DD format)
string
Filter by creation date from (YYYY-MM-DD format)
string
Filter by creation date until (YYYY-MM-DD format)

Dynamic Filters

string
Filter by booking code (partial match supported)
string
Filter by payment status
integer
Filter bookings with minimum duration (in minutes)
integer
Filter bookings with maximum duration (in minutes)
number
Filter bookings with minimum price
number
Filter bookings with maximum price
string
Filter by customer email (partial match supported)
string
Filter by customer phone (partial match supported)

Metadata Filters

boolean
default:"false"
Include booking metadata in response
string
Filter by specific metadata key (requires meta_value)
string
Filter by metadata value (requires meta_key, partial match supported)

Search and Sorting

Search in customer name, email, or booking code
string
default:"start_date"
Sort field (start_date, created_at, customer_name, status, id)
string
default:"desc"
Sort order (asc, desc)

Response

boolean
Always true on success
array
Array of booking objects
object
Pagination information

Examples

Basic Request

Filter by Status and Date

Search by Customer Name or Code

Example Response

Error Responses

Error 401 - Unauthorized
Error 503 - LatePoint not available

Important Notes

Performance: For better performance, use specific filters instead of fetching all bookings and filtering on the client side.
Rate Limiting: This endpoint is subject to rate limiting. Check response headers to monitor your usage.
Pagination: To get all bookings, use the has_next_page field in the response to determine if more pages are available.

Common Use Cases

1. Today’s Bookings Dashboard

2. Customer History

3. Monthly Report