API Reference
Get Dealership
Retrieves the complete dealership profile and configuration for the authenticated dealership.
Authorization
basic AuthorizationBasic <token>
Basic Authorization header
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.dealerai.com/api/v1/dealership"{
"id": "string",
"name": "string",
"multi_manufacturer_ids": [
"string"
],
"region": "string",
"site_url": "string",
"new_car_url": "string",
"used_car_url": "string",
"privacy_url": "string",
"time_zone": "string",
"sms_initial_message": "string",
"ai_activation": true,
"recommended_properties": true,
"open_ai_none_intent_response_enabled": true,
"enable_lease_calculator": true,
"enable_finance_calculator": true,
"contact_info_link": "string",
"send_link_instead_of_contact": true,
"send_link_instead_of_personnel": true,
"car_inventory_link": "string",
"promotion_reply_link": "string",
"send_link_on_null_car_search": true,
"send_promotion_reply_link": true,
"dealer_relationships": {
"parent_dealers": [
"string"
],
"children_dealers": [
"string"
],
"shared_new_inventory_dealers": [
"string"
],
"shared_used_inventory_dealers": [
"string"
],
"shared_details_dealers": [
"string"
]
},
"phone_num": [
{
"name": "string",
"value": "string"
}
],
"email_address": [
{
"name": "string",
"value": "string"
}
],
"send_link_instead_of_address": true,
"portal_chat_settings": {
"receive_notifications": true,
"receive_reps_notifications": true,
"receive_unassigned_notifications": true,
"receive_push_notifications": 0,
"email": "string",
"slack_notification": true,
"slack_notification_url": "string",
"chat_dialog_override": "string"
},
"appointment_settings": {
"service_appointment_settings": {
"is_active": true,
"is_html_email": true,
"html_email_to_emails": [
"string"
],
"html_email_bcc_emails": [
"string"
],
"is_adf_email": true,
"adf_email_to_emails": [
"string"
],
"adf_email_bcc_emails": [
"string"
],
"is_link": true,
"appointment_link": "string",
"appointment_skip_date_time": true,
"lead_time": 0,
"lead_time_unit": 0,
"allow_requests_before_lead_time": true,
"is_trained": true,
"appointment_type": 0,
"appointment_name": "string",
"preferred_time_slots": [
"string"
],
"hours_id": "string",
"bookable_hours_id": "string",
"use_separate_bookable_hours": true,
"is_text_override": true,
"text_override": "string"
},
"lease_return_appointment_settings": {
"is_active": true,
"is_html_email": true,
"html_email_to_emails": [
"string"
],
"html_email_bcc_emails": [
"string"
],
"is_adf_email": true,
"adf_email_to_emails": [
"string"
],
"adf_email_bcc_emails": [
"string"
],
"is_link": true,
"appointment_link": "string",
"appointment_skip_date_time": true,
"lead_time": 0,
"lead_time_unit": 0,
"allow_requests_before_lead_time": true,
"is_trained": true,
"appointment_type": 0,
"appointment_name": "string",
"preferred_time_slots": [
"string"
],
"hours_id": "string",
"bookable_hours_id": "string",
"use_separate_bookable_hours": true,
"is_text_override": true,
"text_override": "string"
},
"test_drive_appointment_settings": {
"is_active": true,
"is_html_email": true,
"html_email_to_emails": [
"string"
],
"html_email_bcc_emails": [
"string"
],
"is_adf_email": true,
"adf_email_to_emails": [
"string"
],
"adf_email_bcc_emails": [
"string"
],
"is_link": true,
"appointment_link": "string",
"lead_time": 0,
"lead_time_unit": 0,
"allow_requests_before_lead_time": true,
"is_trained": true,
"appointment_type": 0,
"appointment_name": "string",
"preferred_time_slots": [
"string"
],
"hours_id": "string",
"bookable_hours_id": "string",
"use_separate_bookable_hours": true,
"is_text_override": true,
"text_override": "string"
},
"sales_appointment_settings": {
"is_active": true,
"is_html_email": true,
"html_email_to_emails": [
"string"
],
"html_email_bcc_emails": [
"string"
],
"is_adf_email": true,
"adf_email_to_emails": [
"string"
],
"adf_email_bcc_emails": [
"string"
],
"is_link": true,
"appointment_link": "string",
"lead_time": 0,
"lead_time_unit": 0,
"allow_requests_before_lead_time": true,
"is_trained": true,
"appointment_type": 0,
"appointment_name": "string",
"preferred_time_slots": [
"string"
],
"hours_id": "string",
"bookable_hours_id": "string",
"use_separate_bookable_hours": true,
"is_text_override": true,
"text_override": "string"
},
"parts_lead_generation_settings": {
"is_active": true,
"is_html_email": true,
"html_email_to_emails": [
"string"
],
"html_email_bcc_emails": [
"string"
],
"is_adf_email": true,
"adf_email_to_emails": [
"string"
],
"adf_email_bcc_emails": [
"string"
],
"is_link": true,
"appointment_link": "string",
"appointment_skip_date_time": true,
"lead_time": 0,
"lead_time_unit": 0,
"allow_requests_before_lead_time": true,
"is_trained": true,
"appointment_type": 0,
"appointment_name": "string",
"respond_with_hours": true,
"hours_id": "string",
"bookable_hours_id": "string",
"use_separate_bookable_hours": true,
"is_text_override": true,
"text_override": "string"
},
"lead_generation_settings": {
"is_html_email": true,
"html_email_to_emails": [
"string"
],
"html_email_bcc_emails": [
"string"
],
"is_adf_email": true,
"adf_email_to_emails": [
"string"
],
"adf_email_bcc_emails": [
"string"
],
"facebook_initial_message_lead_gen_options": true,
"appointment_type": 0,
"appointment_name": "string",
"hours_id": "string",
"bookable_hours_id": "string",
"use_separate_bookable_hours": true,
"is_text_override": true,
"text_override": "string"
},
"trade_in_settings": {
"is_active": true,
"is_html_email": true,
"html_email_to_emails": [
"string"
],
"html_email_bcc_emails": [
"string"
],
"is_adf_email": true,
"adf_email_to_emails": [
"string"
],
"adf_email_bcc_emails": [
"string"
],
"is_link": true,
"appointment_link": "string",
"image_link": "string",
"allow_requests_before_lead_time": true,
"is_trained": true,
"appointment_type": 0,
"appointment_name": "string",
"hours_id": "string",
"bookable_hours_id": "string",
"use_separate_bookable_hours": true,
"is_text_override": true,
"text_override": "string"
}
},
"lease_calculator": {
"lease_information": [
{
"region": "string",
"mileage_unit": "string",
"list_lease_term": [
0
],
"list_lease_mileage": [
0
],
"lease_info": [
[
{
"lease_rate": 0.1,
"lease_residual": 0.1
}
]
]
}
],
"email": "string"
},
"finance_calculator": {
"finance_information": [
{
"region": "string",
"finance_info": [
0.1
],
"finance_term": [
0
]
}
],
"email": "string"
},
"locales": [
{
"locale": "string",
"language": "string",
"is_primary": true,
"is_cjk_language": true,
"is_enabled": true
}
],
"language_support": {
"chinese_support": true,
"french_support": true,
"spanish_support": true,
"korean_support": true,
"is_debug": true
},
"reach_settings": {
"is_active": true,
"sms_auto_response_enabled": true,
"sms_follow_up_enabled": true,
"email_auto_response_enabled": true,
"email_inbound_address": "string",
"email_outbound_address": "string",
"email_subject_type": "string",
"email_subject_preset": "string",
"email_follow_up_enabled": true,
"follow_up": [
{
"value": 0,
"unit": "string"
}
],
"is_white_list": true,
"email_white_list": [
"string"
],
"is_black_list": true,
"email_black_list": [
"string"
],
"is_adf_white_list": true,
"adf_white_list": [
"string"
],
"is_adf_black_list": true,
"adf_black_list": [
"string"
],
"forward_lead_schedule": {
"value": 0,
"unit": "string"
},
"follow_up_hours": {
"name": "string",
"opening": [
"string"
],
"closing": [
"string"
]
}
},
"service_operations": {
"opening": [
"string"
],
"closing": [
"string"
]
},
"is_used_car_dealer": true,
"time_zone_offset": 0.1,
"digital_retail": {
"enabled": true,
"deposit": 0,
"notification_email": "string",
"enable_used_inventory": true,
"enable_new_inventory": true
},
"x_time": {
"enabled": true,
"dealer_code": "string",
"show_services": true
},
"integration_settings": {
"inbound_polling": true,
"inbound_polling_key": "string"
},
"integration_configs": [
{
"key": "string",
"subscription_id": "string"
}
]
}{
"message": "string",
"details": null
}{
"message": "string",
"details": null
}{
"message": "string",
"details": null
}{
"message": "string",
"details": null
}Notifies DealerAI that a retailer has enabled the CreditApp integration.
CreditApp signs the request body with HMAC-SHA256 using the shared secret key and sends the hex-encoded signature in the `X-Credit-App-Signature` header. The dealer is looked up by normalizing `retailerName` to a dealer ID (e.g. "Bob's Motors" → "bobs-motors"). If no matching dealer exists, one is created.
Get Manufacturers
Retrieves a paginated list of all vehicle manufacturers in the system.