Get Referral (v1)
Method & Path
GET /api/v1/workspace/:workspaceId/referrals/:referralId
Actual backend path: /v1/workspace/:workspaceId/referrals/:referralId
Description
Get a single referral by ID.
Authentication
Required: Workspace authentication with appropriate permissions.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer token: Bearer <token> |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | Workspace identifier |
referralId | string | Yes | Referral identifier |
Response 200 OK
{
"id": "507f1f77bcf86cd799439011",
"workspaceId": "507f1f77bcf86cd799439012",
"name": "John Doe",
"email": "john.doe@example.com",
"countryCode": "+1",
"phone": "1234567890",
"whatsappNumber": "+11234567890",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}
Common Errors
- 400 Bad Request: Invalid referral identifier
- 401 Unauthorized: Missing or invalid authentication token
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Workspace or referral not found
- 500 Internal Server Error: Server error