This article provides details on how to use the GET (Public API) endpoint in API V2 to retrieve applicant data.
URL Example
{{url}}/api/apps?app_id=1234&phone=01234567890Request Overview
When making a GET request, third parties can retrieve the following data:
Applicant Details
app_date (Date): Date the application was created.
app_id (Integer): Unique identifier for the application.
uid (String): Application's unique identifier (residence state-related UID).
external_references (Object):
ref_1 (String): External reference 1 (e.g., alv_id).
ref_2 (String): External reference 2 (optional).
ref_3 (String): External reference 3 (optional).
Data Sources
data_sources (Object):
group (String): Data source group (e.g., Telemarketing).
source (String): Data source name (e.g., LIVE TRANSFERS).
Assignees
assignees (Array of Objects):
role_id (String): Role identifier.
role (String): Role name (e.g., Sr Advisor).
user_id (Integer): User identifier.
user_full_name (String): Full name of the user.
email (String): Email address of the user.
voice_phone_number (String): Voice phone number.
voice_ext (String): Phone extension (optional).
personal_phone_number (String): Personal phone number (optional).
Primary Applicant Details
primary_applicant (Object):
first_name (String): First name of the primary applicant.
last_name (String): Last name of the primary applicant.
date_of_birth (Date): Date of birth.
email (String): Email address.
phone_numbers (Object):
cell (String): Cell phone number.
home (String): Home phone number.
work (String): Work phone number.
residence (Object):
address (String): Residence address.
city (String): City of residence.
state (String): State of residence.
zip (String): Zip code.
Workflow Logs
workflow_logs (Object):
current_milestone (String): Latest milestone achieved (e.g., Enrolled).
current_stage (String): Current stage of the application (e.g., ENROLLMENTS | ALV).
current_status (String): Current status of the application (e.g., Client Enrolled).
last_status (String): Previous status before the current one.
days_in_status (Integer): Days the application has been in the current status.
last_status_update_date (Date): Date of the last status update.
last_status_update_actor (String): Actor of the last status update (e.g., Action).
last_contact_attempt_date (Date, Nullable): Date of the last contact attempt.
last_contact_made_date (Date, Nullable): Date of the last successful contact.
Contact Logs
contact_logs (Object):
last_note_date (Date): Date of the most recent note.
last_note (String): Content of the most recent note.
last_call_date (Date, Nullable): Date of the last call related to the application.
last_sms_date (Date, Nullable): Date of the last SMS related to the application.
last_email_date (Date, Nullable): Date of the last email related to the application.
Response Metadata
status (Object):
code (Integer): HTTP response status code.
message (String, Nullable): Additional status message.
Example:
