Overview
General information about the Sophiie API.
The Sophiie API provides REST-style endpoints for webhook integration with Sophiie - a B2B SaaS platform for sales pipeline management. The API handles lead tracking, appointment management, inquiry processing, and webhook subscriptions for automated workflows.
Base URLs
- Production:
https://api.sophiie.ai - Development:
https://api.dev.sophiie.ai
Authentication
All API endpoints require Bearer token authentication. Include your access token in the Authorization header:
Authorization: Bearer <YOUR_ACCESS_TOKEN>HTTP Methods
The Sophiie API follows REST conventions and uses standard HTTP methods:
GET
GET methods are used for retrieving data. Query parameters can be used for filtering when supported.
curl "https://api.sophiie.ai/v1/leads" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"POST
POST methods are used for creating new resources. Data is passed as application/json in the request body.
curl -X POST "https://api.sophiie.ai/v1/leads" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{"name": "John Doe", "email": "john@example.com"}'DELETE
DELETE methods are used for removing resources.
curl -X DELETE "https://api.sophiie.ai/v1/leads/{id}" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"Response Format
All API responses are returned as JSON. Successful responses include the requested data, while error responses follow this structure:
{
"success": false,
"message": "Error description",
"error": {
"status": 401,
"message": "invalid_token"
}
}OpenAPI Specification
The complete OpenAPI specification for the Sophiie API is available at:
https://api.sophiie.ai/openapi
Available Resources
The Sophiie API provides endpoints for:
- Leads: Retrieve recent leads with contact information and status
- Appointments: Access appointment data including attendees, schedule, and lead information
- Inquiries: Get inquiry data with key points, source information, and lead details
- Organization: Retrieve organization information