Query Lead Status within the Convoso system.
Endpoint:
GET https://api.convoso.com/v1/status/search
đź”’ Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | API key for authentication. |
| query | string | Yes | Search status abbreviation or description. |
Example Request
GET https://api.convoso.com/v1/status/search?auth_token=your_auth_token&query=
Response Format (JSON)
{
"success": true,
"code": 200,
"data": [
{
"status": "NEW",
"name": "New Lead",
"final": "N",
"reached": "N",
"success": "N",
"dnc": "N",
"callback": "N",
"contact": "N",
"voicemail": "N",
"workflow_dispositon_event_option": 1,
"custom_status": "N"
}
]
}Response Field Definitions
Top-Level Data Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Identifies if the API was executed successfully |
| code | integer | Response Code for API call |
| data | array[] | Array of Status Codes |
Data Object
| Field | Type | Description |
|---|---|---|
| status | string | Unique identifier for the new status (e.g., "Custom"). Must be 2-6 characters |
| name | string | Human-readable name for the status. |
| hex_color | string | Hexadecimal color code for UI representation (e.g., "6711d1"). |
| final | string | Indicates if the status is final. Accepts "Y" or "N". |
| reached | string | Indicates if the lead was reached. Accepts "Y" or "N". |
| success | string | Indicates if the status signifies a successful outcome. Accepts "Y" or "N". |
| dnc | string | Marks the lead as Do Not Call. Accepts "Y" or "N". |
| callback | string | Indicates if a callback is required. Accepts "Y" or "N". |
| contact | string | Indicates if contact was made. Accepts "Y" or "N". |
| voicemail | string | Indicates if a voicemail was detected Accepts "Y" or "N". |
| workflow_disposition_event_option | integer | Indicates if the status is available as part of a workflow disposition. |