Introduction
Introduction
Overview of the SkyLight Chat REST API — what it can do, how it works, and what you need to get started.
What is the SkyLight Chat API?
The SkyLight Chat REST API gives developers full programmatic access to the SkyLight Chat platform. Using your client API key, you can:
- Manage contacts — create, search, tag, segment, and blacklist
- Send messages across WhatsApp, Telegram, and Instagram
- Manage bookings — create appointments, check availability, list resources
- Configure webhooks — receive real-time events for contacts, messages, bookings, and tickets
- Manage your team — create team members, set roles, update or remove them
- Read account details — subscription plan, channel connection status, usage limits
All endpoints live under:
https://dashboard.skylightchat.com/api/v1/
API versioning
The current stable version is v1. The version is part of the URL path (/api/v1/). When breaking changes are introduced, a new version will be published alongside the existing one with a deprecation notice.
Base URL
https://dashboard.skylightchat.com/api/v1
Response format
All responses are JSON. Successful responses follow this structure:
{
"success": true,
"data": { ... },
"message": "Optional contextual message"
}
Paginated list responses include a meta object:
{
"success": true,
"data": [ ... ],
"meta": {
"current_page": 1,
"last_page": 4,
"per_page": 15,
"total": 58
}
}
Error responses always include success: false:
{
"success": false,
"message": "Human-readable error description",
"errors": { "field": ["Validation message"] }
}
