Customer Object

An object containing comprehensive information about a customer, including personal details, contact information, and various associated metadata.

Table of Customer Object

Value NameDescriptionValue Type
company_idThe identifier for the company associated with the customer.integer
office_idThe identifier for the office handling this customer.integer
creator_idThe identifier for the user who created the customer record.integer
agent_idThe identifier for the agent assigned to the customer.integer
setter_idThe identifier for the setter assigned to the customer.integer
first_nameThe first name of the customer.string
last_nameThe last name of the customer.string
emailThe primary email address of the customer.string
mobileThe primary mobile number of the customer.string
secondary_first_nameThe first name of the secondary contact, if applicable.string
secondary_last_nameThe last name of the secondary contact, if applicable.string
secondary_mobileThe mobile number of the secondary contact, if applicable.string
secondary_emailThe email address of the secondary contact, if applicable.string
addressThe street address of the customer.string
cityThe city where the customer resides.string
stateThe state abbreviation where the customer resides.string
zipThe postal code for the customer's address.string
countyThe county where the customer resides.string
latThe latitude coordinate of the customer's location.string
lngThe longitude coordinate of the customer's location.string
timezoneThe time zone of the customer's location.string
detailsAdditional details about the customer. null if not provided.string
external_idAn external ID for the customer, if applicable. null if not availablestring
lead_sourceThe source from which the lead was generated.string
meta_dataMetadata associated with the customer, detailing the class, method, and other relevant data points.object
status_idThe status identifier for the customer.integer
lead_router_idThe identifier for the lead router, if applicable. null if not assignedinteger
referral_idThe identifier for the referral, if applicable. null if not assigned.integer
deleted_atThe timestamp when the customer record was deleted, if applicable. null if not deleted.string
languageThe language preference of the customer.string
unit_numberThe unit or apartment number in the customer's address.integer
initial_contactThe identifier for the initial contact status.integer
deleted_byThe identifier for the user who deleted the record, if applicable. null if not deleted.integer
fullNameThe full name of the customer, a combination of first and last names.string
idThe unique identifier for the customer.integer
createdThe timestamp when the customer record was created.string
updatedThe timestamp when the customer record was last updated.string (YYYY-MM-DDTHH:MM:SS+00:00)
fullStateThe full name of the state where the customer resides.string
status_nameThe name associated with the customer's status, if applicable. null if not provided.string
created_by_nameThe full name of the user who created the customer record.string
created_by_emailThe email address of the user who created the customer record.string
created_by_phoneThe phone number of the user who created the customer record.string
creatorDetails about the user who created the customer record.object
integrationsIntegration details related to the customer. Integrationsobject
ownerInformation about the owner of the customer record.object
officeAn object containing information about the office associated with the customer or company.object
companyAn object providing details about the company associated with the customer or officeobject
customer_notesNotes or additional information about the customer. Empty if not provided.string
futureAppointmentsA list of future appointments scheduled for the customer. Empty array if none are scheduled.array
customer_portal_urlThe URL link to the customer portal.string
customer_google_drive_folderThe URL link to the customer's Google Drive folder.string
surveysAn object containing information about the different surveys associated with the customer or company. Each survey is represented as a nested object within surveys.object
loan_application_detailsAn object containing information about the customer's loan application status.object

Below is an example of the Customer Object

"customer": {
			"company_id": 0000,
			"office_id": 0000,
			"creator_id": 00000,
			"agent_id": 00000,
			"setter_id": null,
			"first_name": "FirstName",
			"last_name": "LastName",
			"email": "[email protected]",
			"mobile": "0000000000",
			"secondary_first_name": "",
			"secondary_last_name": "",
			"secondary_mobile": "",
			"secondary_email": "",
			"address": "123 Main St",
			"city": "Huntington Beach",
			"state": "CA",
			"zip": "92605",
			"county": "Orange County",
			"lat": "33.660057",
			"lng": "-117.998970",
			"timezone": "America/Los_Angeles",
			"details": null,
			"external_id": null,
			"lead_source": "Facebook",
			"meta_data": {
				"class": "App\\Http\\Controllers\\CustomerController",
				"method": "in_app",
				"function": "addCustomer",
				"has_valid_email": 0,
				"primary_sms_supported": 0,
				"invalidEmailNotificationSent": 1
			},
			"status_id": -1,
			"lead_router_id": null,
			"referral_id": null,
			"deleted_at": null,
			"language": "en_US",
			"unit_number": "",
			"initial_contact": 0,
			"deleted_by": null,
			"fullName": "FirstName LastName",
			"id": 0000000,
			"created": "2024-08-09T15:26:39+00:00",
			"updated": "2024-08-13T20:23:39+00:00",
			"fullState": "California",
			"fullAddress": "123 Main St., Huntington Beach, CA 92605",
			"status_name": null,
			"created_by_name": "Enerflo Admin",
			"created_by_email": "[email protected]",
			"created_by_phone": "(000) 000-0000",
			"creator": {
				"first_name": "Enerflo",
				"last_name": "Admin",
				"email": "[email protected]",
				"phone": "0000000000",
				"timezone": "America/Los_Angeles",
				"id": 00001
			},
			"integrations": {
				"Enerflo V2": {
					"EnerfloV2Customer": {
						"integration_record_id": "0ab00a00-0000-000a-000d-0cc000dc0000",
						"record_type": "EnerfloV2Customer",
						"enerflo_id": 000000,
						"last_synced": "2024-08-09T15:26:39+00:00",
						"updated_at": "2024-08-09T15:26:39+00:00",
						"created_at": "2024-08-09T15:26:39+00:00"
					}
				}
			},
			"owner": {
				"first_name": "Enerflo",
				"last_name": "Admin",
				"email": "[email protected]",
				"valid_email": 1,
				"phone": "1111111111",
				"timezone": "America/Los_Angeles",
				"is_active": 1,
				"id": 00000,
				"meta": {
					"inactive": "0",
					"solo_email": "[email protected]",
					"intercom_id": "00c0caa0d0e00000000b0ae0",
					"aurora_email": null,
					"is_view_only": "0",
					"allow_optimus": "1",
					"notifications": {
						"dealFeedEmail": "1"
					},
					"valid_email_ts": "2024-07-17 23:53:39",
					"has_valid_email": 1,
					"solo_email_3104": "[email protected]",
					"sales_rep_license": null,
					"can_create_customers": "1",
					"primary_sms_supported": 0,
					"can_create_manual_installs": "1",
					"create_update_change_order": "1"
				}
			},
      "office": {
				"office_name": "Enerflo Office",
				"office_id": 0001,
				"office_city": "Huntington Beach",
				"office_address": "1234 Main St.",
				"office_zip": "92605",
				"office_tz": "America/Los_Angeles",
				"office_state": "CA",
				"sms_number": "0000000000"
			},
     "company": {
				"company_name": "Enerflo Solar",
				"company_phone": "0000000000",
				"company_address": "1234 Main St.",
				"company_city": "Huntington Beach",
				"company_state": "CA",
				"company_zip": "92605",
				"company_email": "[email protected]",
				"company_timezone": "America/Los_Angeles"
			},
      "customer_notes": "",
			"futureAppointments": [],
			"customer_portal_url": "https://enerflo.io/us/A1BC01",
			"customer_google_drive_folder": "https://drive.google.com/drive/u/1/folders/",
			"surveys": {
				"Enerflo Solar - v2 Manual Deal": {
					"name": "Enerflo Solar - v2 Manual Deal",
					"type": "sales",
					"id": 0000000,
					"install": {
						"id": 0000000,
						"status": null,
						"created_at": 4429729,
						"updated_at": 4429729
					}
				}
			},
			"loan_application_details": {
				"lender": "N/A",
				"application_status": "N/A",
				"application_date": "N/A"
			}
		}