Skip to main content
GET
/
leads
/
{uuid}
Get a lead
curl --request GET \
  --url https://api.journeybee.io/v1/leads/{uuid} \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "company_name": "<string>",
  "source": "<string>",
  "rejected_reason": "<string>",
  "direction": "<string>",
  "partner": {
    "uuid": "<string>",
    "name": "<string>"
  },
  "created_by": {
    "uuid": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>"
  },
  "tags": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "assigned_users": [
    {
      "uuid": "<string>",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  ],
  "custom_fields": [
    {
      "uuid": "<string>",
      "label": "<string>",
      "value": {
        "text": "<string>",
        "number": 123,
        "date": "<string>",
        "boolean": true,
        "select": 123,
        "multi_select": [
          123
        ]
      },
      "options": [
        {
          "id": 123,
          "label": "<string>"
        }
      ]
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

uuid
string
required
first_name
string | null
required
last_name
string | null
required
email
string | null
required
phone_number
string | null
required
company_name
string | null
required
source
string
required
status
enum<string>
required
Available options:
new,
converted,
rejected
rejected_reason
string | null
required
direction
string | null
required
partner
object
required
created_by
object
required
tags
object[]
required
assigned_users
object[]
required
custom_fields
object[]
required
created_at
string
required
updated_at
string
required