Skip to main content
GET
Get a lead

Authorizations

Authorization
string
header
required

Access token issued by POST /sessions and associated with a valid server-side session.

Path Parameters

id
string<uuid>
required

UUID identifying this resource.

Query Parameters

company_id
string<uuid>
required

Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.

school_id
string<uuid>
required

School UUID.

fields
enum<string>[]

Select response properties. Unknown names return 400. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

Available options:
lead_id,
monday_item_id,
first_name,
last_name,
school_id,
school_name,
status,
date_of_birth,
current_age,
intended_start_date,
periods_lead_room_available,
parent1_name,
parent1_email,
parent1_mobile,
created_at,
updated_at,
available_space,
source,
intellikid_status,
intellikid_children_status,
intellikid_lead_status,
intellikid_source,
notes,
student_status,
onboarding_status,
ems_status,
start_date,
withdrawal_date,
lineleader_child_id,
lineleader_family_id,
lineleader_center_id,
lineleader_center_name,
lineleader_status,
lineleader_classroom,
stage_inquiry_call_completed,
stage_tour_completed,
stage_not_viable,
stage_not_interested,
stage_no_response,
stage_no_response_timed_out,
is_crm_intended_start_date,
lead_to_enrollment_date,
age_at_start_date_months,
age_at_lead_created_at_months,
alerts

Response

Successful response.

Lead.

lead_id
string
required

Lead id.

monday_item_id
string
required

Monday item id.

first_name
string
required
last_name
string
required
school_id
string
required

School id.

school_name
string
required
status
string
required
date_of_birth
string
required
current_age
number<double> | null
required

Child age in months.

intended_start_date
string
required
periods_lead_room_available
object[] | null
required
parent1_name
string
required
parent1_email
string
required
parent1_mobile
string
required
created_at
string
required
updated_at
string
required
available_space
string
required
available_space_match
string
required
available_space_match_persisted
string<date-time> | null
required
source
string
required
intellikid_status
string
required
intellikid_children_status
string
required
intellikid_lead_status
string
required
intellikid_source
string
required
notes
string
required
student_status
string
required
procare_desktop_enrollment_status
string
required
onboarding_status
string
required
ems_status
string
required
start_date
string
required
withdrawal_date
string
required
lineleader_child_id
integer | null
required
lineleader_family_id
integer | null
required
lineleader_center_id
integer | null
required
lineleader_center_name
string | null
required
lineleader_status
string | null
required
lineleader_classroom
string | null
required
lineleader_child_flagged_as_duplicated
boolean
required
stage_inquiry_call_completed
string
required

Stage value as a string in the read representation; PATCH uses a boolean.

stage_tour_completed
string
required

Stage value as a string in the read representation; PATCH uses a boolean.

stage_not_viable
string
required

Stage value as a string in the read representation; PATCH uses a boolean.

stage_not_interested
string
required

Stage value as a string in the read representation; PATCH uses a boolean.

stage_no_response
string
required

Stage value as a string in the read representation; PATCH uses a boolean.

stage_no_response_timed_out
string
required

Stage value as a string in the read representation; PATCH uses a boolean.

is_crm_intended_start_date
boolean
required
lead_to_enrollment_date
number<double> | null
required
age_at_start_date_months
number<double> | null
required
age_at_lead_created_at_months
number<double> | null
required
alerts
object[] | null
required