GET
/
api
/
v1
/
companies
/
{companyId}
/
leads
/
{leadId}
Get Individual Lead
curl --request GET \
  --url https://app.journeybee.io/api/v1/companies/{companyId}/leads/{leadId} \
  --header 'Authorization: Bearer <token>'
{
  "id": 789,
  "uuid": "lead-uuid-789",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T12:45:00Z",
  "source": "partnership",
  "company_name": "TechCorp Solutions",
  "email": "contact@techcorp.com",
  "phone_number": "+1-555-123-4567",
  "first_name": "John",
  "last_name": "Smith",
  "status": "new",
  "partner_type": "referral",
  "company_id": 123,
  "created_by_user_id": 456,
  "custom_fields": [
    {
      "id": 5,
      "label": "Revenue Potential",
      "type": "number",
      "value": {
        "number": 100000
      },
      "custom_field_value_id": 123
    }
  ],
  "tags": [
    {
      "id": 10,
      "label": "High Priority",
      "background_color": "#EF4444",
      "text_color": "#FFFFFF"
    }
  ],
  "assigned_users": [
    {
      "id": 456,
      "email": "jane@company.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "color": "#3B82F6"
    }
  ],
  "partnership_leads": [
    {
      "id": 123,
      "partnership_id": 456,
      "sent_by_company_name": "Partner Corp",
      "direction": "received"
    }
  ],
  "lead_deals": [
    {
      "id": 345,
      "label": "TechCorp Deal",
      "deal_value": 50000,
      "stage_label": "Proposal"
    }
  ]
}

​
Authentication

curl -X GET "https://app.journeybee.io/api/v1/companies/{companyId}/leads/{leadId}" \
  -H "Authorization: Bearer your-api-key-uuid" \
  -H "Content-Type: application/json"

​
Path Parameters

​
companyId
number
required
The unique identifier of the company
​
leadId
number
required
The unique identifier of the lead

​
Response Schema

​
lead
object
Detailed lead object

​
Example Response

{
  "id": 789,
  "uuid": "lead-uuid-789",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T12:45:00Z",
  "source": "partnership",
  "company_name": "TechCorp Solutions",
  "email": "contact@techcorp.com",
  "phone_number": "+1-555-123-4567",
  "first_name": "John",
  "last_name": "Smith",
  "status": "new",
  "partner_type": "referral",
  "company_id": 123,
  "created_by_user_id": 456,
  "custom_fields": [
    {
      "id": 5,
      "label": "Revenue Potential",
      "type": "number",
      "value": {
        "number": 100000
      },
      "custom_field_value_id": 123
    }
  ],
  "tags": [
    {
      "id": 10,
      "label": "High Priority",
      "background_color": "#EF4444",
      "text_color": "#FFFFFF"
    }
  ],
  "assigned_users": [
    {
      "id": 456,
      "email": "jane@company.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "color": "#3B82F6"
    }
  ],
  "partnership_leads": [
    {
      "id": 123,
      "partnership_id": 456,
      "sent_by_company_name": "Partner Corp",
      "direction": "received"
    }
  ],
  "lead_deals": [
    {
      "id": 345,
      "label": "TechCorp Deal",
      "deal_value": 50000,
      "stage_label": "Proposal"
    }
  ]
}

​
Notes

  • Requires API key with read_access permission
  • Returns comprehensive lead details including relationships
  • Used for lead detail views and form population