DealerAI
API Reference

Get Conversations with Filtering and Pagination

Retrieves a paginated list of conversations for the authenticated dealership with optional filtering by channel, status, dates, and archived status. Results are ordered by LastModifiedDate.

GET
/api/v1/conversation

Authorization

basic
AuthorizationBasic <token>

Basic Authorization header

In: header

Query Parameters

Take?integer

Gets or sets the maximum number of rows to take (overrides base to set max to 100).

Formatint32
Range1 <= value <= 100
Channel?string

Gets or sets the channel filter (e.g., "sms", "email", "webchat").

CreatedDateFrom?string

Gets or sets the start date filter for created date.

Formatdate-time
CreatedDateTo?string

Gets or sets the end date filter for created date.

Formatdate-time
ModifiedDateFrom?string

Gets or sets the start date filter for modified date.

Formatdate-time
ModifiedDateTo?string

Gets or sets the end date filter for modified date.

Formatdate-time
Status?string

Gets or sets the conversation status filter (e.g., "Active", "Ended", "Paused").

IncludeIsArchived?boolean

Gets or sets a value indicating whether to include archived conversations.

SortOrder?string

Gets or sets the sort order ("asc" or "desc"). Default is descending.

Skip?integer

Gets or sets the number of rows to skip.

Formatint32
Range0 <= value <= 2147483647

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.dealerai.com/api/v1/conversation"
{
  "total_row_count": 0,
  "row_count": 0,
  "rows": [
    {
      "conversation_id": "string",
      "dealer_id": "string",
      "channel": "string",
      "contact_info": {
        "full_name": "string",
        "email": "string",
        "phone": "string"
      },
      "is_likely_spam": true,
      "flag": [
        "string"
      ],
      "is_archived": true,
      "status": "string",
      "is_adf": true,
      "message_count": 0,
      "created_date": "2019-08-24T14:15:22Z",
      "last_online_date_time": "2019-08-24T14:15:22Z",
      "last_modified_date": "2019-08-24T14:15:22Z",
      "messages": [
        {
          "role": "string",
          "text": "string",
          "attachments": [
            {
              "content_type": "string",
              "content_url": "string",
              "content": null,
              "name": "string"
            }
          ],
          "date_created": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ]
}
{
  "message": "string",
  "details": null
}
{
  "message": "string",
  "details": null
}
{
  "message": "string",
  "details": null
}

Get Conversation by ConversationId

Retrieves conversation data including user information, status, and optionally messages for the specified conversation ID.

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.