HYEGRO CRM v1.0.0 is now LIVE!!

Read Lead By Id

GET

https://backend.test-hyegro.com/leads/{lead_id}

Retrieve a lead by its ID.

Args:
lead_id (int): The ID of the lead to retrieve.
db (Session): The database session.
current_user (schemas.User): The user requesting the lead.

Returns:
schemas.Lead: The retrieved lead.

Request

Path Params

Query Params

Responses

🟢200OK

application/json

Successful Response

Body

Example

{
    "full_lead_name": "string",
    "lead_source": "string",
    "first_name": "string",
    "last_name": "string",
    "company_name": "string",
    "title": "string",
    "industry": "string",
    "email": "user@example.com",
    "phone": "string",
    "mobile": "string",
    "lead_status": "string",
    "lead_rating": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal_code": "string",
    "website": "string",
    "annual_revenue": 0,
    "currency": "string",
    "number_of_employees": 0,
    "notes": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated_by": 0,
    "created_by_name": "string",
    "updated_by_name": "string",
    "interested_products": [
        "string"
    ],
    "assigned_to": 0,
    "assigned_to_name": "string",
    "last_activity": "2019-08-24T14:15:22Z",
    "salutation": "string",
    "designation": "string",
    "lead_score": 0,
    "cf1": "string",
    "cf2": "string",
    "cf3": "string",
    "cf4": "string",
    "cf5": "string",
    "cf6": "string",
    "cf7": "string",
    "cf8": "string",
    "cf9": "string",
    "cf10": "string",
    "id": 0
}

🟠422Parameter Error

Modified at 2025-04-15 14:01:55

Bulk Upload Leads

Update Lead