Allows the searching of Lists within a specific Convoso account.
Endpoint:
POST https://api.convoso.com/v1/list/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. |
| status | string | Yes | The status of the list. 0 (Inactive), 1 (Active) |
| id | string | No | List Identifiers. |
| campaign_id | string | No | List filter based on list campaign assignment. |
Example Request
POST https://api.convoso.com/v1/lists/search?auth_token=your_auth_token&id=&campaign_id=&status=1
Response Format (JSON)
{
"success": true,
"data": [
{
"id": 2705,
"name": "Your List Name",
"status": "Y",
"last_called_at": null
}
]
}
Response Field Definitions
Top-Level Data Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Identifies if the API was executed successfully |
| data | object | Data Object |
Data Object
| Field | Type | Description |
|---|---|---|
| list_id | integer | List identifier |
| name | string | Name of the lead list |
| status | string | Status of the list. Y (Active), N (Inactive) |
| last_called_at | string | The date and time of the last call made against a lead in the list. |