Documentation & API Reference
Welcome to the WSP CRM Developer Docs. Here you will find guides, concepts, and API references to help you integrate WSP CRM into your custom software ecosystem, synchronize databases, and automate your sales pipeline.
Our API is built on RESTful principles, returns JSON-encoded responses, and uses standard HTTP response codes to communicate errors.
Quickstart Guide
To begin making calls to the API, you must first retrieve an API Access Token. Access Tokens are issued within your CRM Settings page (Admin only).
Include the access token in the HTTP header of all requests:
Authorization: Bearer YOUR_API_ACCESS_TOKEN
Authentication API
Perform programmatic agent sign-in or generate JWT credentials using the login endpoint:
POST /api/users/login
Content-Type: application/json
{ "email": "agent@company.com", "password": "yourpassword" }
Content-Type: application/json
{ "email": "agent@company.com", "password": "yourpassword" }
A successful login response returns user statistics along with the active JWT validation token.