---
title: VENICE API Documentation
---
# VENICE API Documentation
# Authorization Request:
To authorize, send a request to:
```plaintext
POST https://take-leads.xyz/api/login?email={email}&password={password}
```
### Parameters:
- **Email:** `{email}`
- **Password:** `{password}`
### Example of a Successful Request:
```json
{
"success": true,
"data": {
"token": "token",
"name": "SourceName",
"role": "web_master"
},
"message": "User login successfully."
}
```
# Lead Creation:
To create a lead, use the following request:
## POST Request:
```plaintext
POST https://take-leads.xyz/api/leads
```
## Headers:
```plaintext
Accept: application/json
Content-Type: application/x-www-form-urlencoded
```
## Body (x-www-form-urlencoded):
| Parameter | Description |
|----------------|--------------------------------------------------------------------------------------------------------|
| `full_name` | First name + last name |
| `email` | Lead's email address (must be valid and will be verified via external validation tools) |
| `landing_name` | The value depends on the funnel you are using (contact us to get the funnel slug) |
| `user_id` | Your user_id |
| `ip` | Client's IP address (if needed to override) |
| `phone` | Phone number without '+' |
| `landing` | Landing URL |
| `country` | Country code in ISO 3166-1 alpha-2 format |
| `source` | Source name |
### Example of a Successful Response:
```json
{
"status": true,
"external_id": 74532,
"link_auto_login": "https://autologin.com",
"lead_id": 1234
}
```
### Example of a Failed Request:
```json
{
"status": false,
"error": "There was an error processing your request, please try again later or contact technical support"
}
```
# Retrieving Lead Statuses:
To retrieve lead statuses, use the following request:
## GET Request:
```plaintext
GET https://take-leads.xyz/api/web-master/leads
```
## Headers:
```plaintext
Content-Type: application/json
Authorization: Bearer {your token}
```
### Example of a Successful Request:
```json
{
"success": true,
"data": {
"data": [
{
"id": 1019,
"full_name": "Fname Lname",
"landing_id": 147,
"country_id": 56,
"status_id": 1,
"landing_name_id": 17,
"is_action": 0,
"action_time": null,
"query_parameters": "",
"date": "2024-01-01 18:18:48",
"country": {
"id": 56,
"ISO_2": "CZ"
},
"status": {
"id": 1,
"name": "New"
},
"landing_name": {
"id": 17,
"name": "landing_name"
},
"landing": {
"id": 197,
"url": "test"
}
}
],
"current_page": 1,
"total_pages": 1,
"total": 1
},
"message": "Leads collection"
}
```