1. Leads
LeadsyGroup
  • API V1
    • Users
      • Remove a user avatar
      • Upload a user avatar
      • Create a user
      • Validate JWT
      • Find a user by email
      • Show all users
      • Login into the application
      • Reset user password
      • Show a user
      • Update a user
    • Stages
      • List stages
    • Companies
      • Remove a company avatar
      • Upload a company avatar
      • Create company
      • List companies
      • Get an specific company
    • User Onboarding
      • Mark as completed the onboarding
      • Approve T&C
    • User Company Relation
      • Create user_accesses for a user
      • Show user_accesses for a user
      • Remove an specific user_access
      • Update user_accesses for a user
    • Accesses
      • List all available accesses
      • List access by id
    • Memberships
      • List available memberships
      • Info of a membership
    • Legal Terms
      • Current available for signature
      • Get legal terms per id
    • Invitations
      • Get all pending invitations for a company
      • Get invitation by code (no auth required)
      • Creates user invitation
      • Delete an invitation
      • Get pending invitations by email
    • Import
      • Import leads for a company
      • Download leads import template for a company
      • List of ImportFiles
      • Check status of an import
    • Campaigns
      • List campaigns for a company
      • Get campaign by id
    • Questions
      • Bulk update question options for a campaign
      • List questions for a campaign
      • Get question for ID
      • Create a question for company
      • List questions for a company
      • Delete a question for company
      • Modify questions priority order for a company
    • Cycles
      • Modify cycles flag in company
      • Create a cycle for company
    • Membership
      • Attach membership to company
      • Cancel current subscription
    • Company Users
      • Get users from an specific company
    • Leads
      • Create a lead for a company
        POST
      • List company leads
        GET
      • List duplicate company leads
        GET
      • List unassigned company leads
        GET
      • List lead metrics by stage
        GET
      • Get lead by id
        GET
      • Update a lead
        PUT
    • Lead Notes
      • Create a note for a lead
      • Delete a note from a lead
    • User Providers
      • Show providers for a user
    • Sources
      • Create a source for a company
      • List sources for a company
      • Delete a source for company
      • Modify sources priority order for a company
      • Assign a user access to a source
      • Remove a user access from a source
    • Appointments
      • List appointments for the current user
      • Get appointment by id
    • Territories
      • Create territories for a company
      • List territories for a company
  1. Leads

Get lead by id

GET
/api/v1/companies/{company_id}/leads/{id}

Request

Path Params

Header Params

Responses

🟢200
application/json
Lead information
Bodyapplication/json

🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/companies//leads/' \
--header 'Authorization;'
Response Response Example
200 - Example 1
{
    "lead": {
        "id": 0,
        "full_name": "string",
        "zip_code": "string",
        "campaign_name": "string",
        "ad_name": "string",
        "platform": "string",
        "creation_source": "string",
        "confirmation_phone": "string",
        "is_valid_zip_code": true,
        "secondary_phone_valid": true,
        "lead_date": "string",
        "has_lead_notes": true,
        "participant": {
            "id": 0,
            "token": "string",
            "email": "string",
            "phone_number": "string",
            "first_application_at": "string",
            "last_application_at": "string",
            "primary_phone_valid": true
        },
        "assigned_to": {
            "id": 0,
            "status": "string",
            "assigned_at": "string",
            "user": {
                "id": 0,
                "name": "string",
                "avatar_url": "string"
            }
        },
        "lead_answers": [
            {
                "id": 0,
                "value": "string",
                "question": {
                    "question_label": "string",
                    "question_text": "string"
                }
            }
        ],
        "notes": [
            {
                "id": 0,
                "token": "string",
                "lead_id": 0,
                "comment": "string",
                "participant_token": "string",
                "can_archive_note": true,
                "creation_time_in_utc": "string",
                "creation_time_in_creator_timezone": "string",
                "creator": {
                    "id": 0,
                    "full_name": "string",
                    "avatar_route": "string"
                }
            }
        ],
        "stage": {
            "id": 0,
            "label": "string",
            "hex_color": "string",
            "stage_type": "string",
            "label_translate": {},
            "priority": 0,
            "icon_type": "string",
            "icon_color": "string"
        },
        "address": {
            "id": 0,
            "value": "string",
            "latitude": 0,
            "longitude": 0,
            "coordinates": {},
            "address_comments": "string",
            "is_valid_address": true
        }
    }
}
Modified at 2026-03-23 15:30:28
Previous
List lead metrics by stage
Next
Update a lead
Built with