Search business data

Overview

Searches across business data entities including clients, conversations, bookings, appointments, estimates, payments, and documents. The search is powered by an Elasticsearch-based Seeker service.

The behavior varies depending on the entity parameter:

• No entity or general entities: Returns a combined result with top_hits grouped by entity type and counts per entity type.
• entity=appointment: Returns a decorated list of appointments with pagination support for recurring appointment series.
• entity=event_instance: Returns a decorated list of event instances with standard pagination.

Rate Limiting

This endpoint is rate-limited to 60 requests per 60 seconds per staff member. Exceeding the limit returns a 429 Too Many Requests response.

Staff Permissions

Search results are filtered based on the requesting staff member's permissions:

• Clients are scoped to the staff member's accessible clients unless they have full access.
• Payment and document results are hidden if the staff member lacks view permissions for those entities.
• Client email, phone, and last name visibility depends on the staff's model view permissions.

Available for Staff and Internal tokens.