Qualified API Reference (v1)

The Qualified API allows developers to access Qualified resources. API URLs are resource based with standard HTTP authentication and verbs. Responses have a JSON body with HTTP response codes.

Authentication

Request authentication is done using HTTP basic auth. Only a API key is needed. Provide the API key for requests via bearer auth, ie -H Authorization: Bearer pUBrwGZJh2wpjhz3tVnMdwqB.

Bot Conversations

Visitors have conversations with bots on the Qualified platform. Bot conversations during a visitor’s website session will be available for querying once the website session ends.

query Parameters
starting_after
string

An object id used as a cursor for pagination. Bot conversations are ordered chronologically by their object id. For example, if you receive 100 bot conversations, ending with a bot conversation with id XYZ, a request with starting_after=XYZ will fetch the subsequent bot conversations.

limit
integer <= 10000
Default: 10000

Maximum number of bot conversations that will be returned. If a limit greater than the max is specified, an error will return.

header Parameters
Authorization
required
string
Example: Bearer <TOKEN>

Responses

Response Schema: application/json
Array of objects (BotConversation)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "4FVuPvLDgBueArvHZ3uAcYnAkhcMSGUXjkAe",
      • "started_at": "2019-08-24T14:15:22Z",
      • "visitor": {
        • "id": "gcyn8DZod4KqmfnWp5WHHa5zSJWnBjQ6T81as",
        • "email": "example@apple.com",
        • "salesforce_lead_id": "0011U00001R5lpOPCM",
        • "salesforce_contact_id": "00Q1U00000U7BkFUNM",
        • "pardot_prospect_id": 23045042,
        • "marketo_lead_id": 9204305,
        • "hubspot_contact_id": 143209560,
        • "eloqua_contact_id": 275324,
        • "outreach_prospect_id": 321731
        },
      • "bot": {
        • "id": "MfUGgqXoKEHJdu8YMMBzWFuBKFHunWHv1f",
        • "name": "Welcome greeting"
        },
      • "rep_conversation_id": "gct6jvH379QyHnoX3x83pgq3ktk5d1KUCKvbq",
      • "salesforce_lead_captured_by_bot": false,
      • "pardot_prospect_captured_by_bot": false,
      • "marketo_lead_captured_by_bot": false,
      • "eloqua_contact_captured_by_bot": false,
      • "meetings": [
        • {
          • "offer_sent_at": "2019-08-24T14:15:22Z",
          • "booked_user_id": "gcypWVVAM2rYrfP6utuFbYnzf59yRTps5se9e"
          }
        ],
      • "calls": [
        • {
          • "started_at": "2019-08-24T14:15:22Z",
          • "ended_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "messages": [
        • {
          • "sent_at": "2019-08-24T14:15:22Z",
          • "visitor_id": "gct6jvH379QyHnoX3x83pgq3ktk5d1KUCKvbq",
          • "bot_id": null,
          • "user_id": null,
          • "text": "hello! I'm a human"
          }
        ]
      }
    ],
  • "meta": {
    • "ending_cursor": "gcA9x9RJmawe1oKWow8Pwk8KCm9j25yUNV2ZJ",
    • "has_more": true
    }
}

Rep Conversations

Visitors have conversations with reps on the Qualified platform. Rep conversations during a visitor’s website session will be available for querying once the website session ends.

query Parameters
starting_after
string

An object id used as a cursor for pagination. Rep conversations are ordered chronologically by their object id. For example, if you receive 100 rep conversations, ending with a rep conversation with id XYZ, a request with starting_after=XYZ will fetch the subsequent rep conversations.

limit
integer <= 10000
Default: 10000

Maximum number of rep conversations that will be returned. If a limit greater than the max is specified, an error will return.

header Parameters
Authorization
required
string
Example: Bearer <TOKEN>

Responses

Response Schema: application/json
Array of objects (RepConversation)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "gcA9xf9pxhQDbCsC67PzMD4cxaw6dqcTvsUhm",
      • "started_at": "2019-08-24T14:15:22Z",
      • "visitor": {
        • "id": "gcyn8DZod4KqmfnWp5WHHa5zSJWnBjQ6T81as",
        • "email": "example@apple.com",
        • "salesforce_lead_id": "0011U00001R5lpOPCM",
        • "salesforce_contact_id": "00Q1U00000U7BkFUNM",
        • "pardot_prospect_id": 23045042,
        • "marketo_lead_id": 9204305,
        • "hubspot_contact_id": 143209560,
        • "eloqua_contact_id": 275324,
        • "outreach_prospect_id": 321731
        },
      • "user": {
        • "id": "gcyn8DZod4KqmfnWp5WHHa5zSJWnBjQ6T81as",
        • "email": "example@apple.com",
        • "name": "Amy the rep"
        },
      • "bot_conversation_id": "gct6jvH379QyHnoX3x83pgq3ktk5d1KUCKvbq",
      • "salesforce_lead_captured_by_rep": false,
      • "pardot_prospect_captured_by_rep": false,
      • "marketo_lead_captured_by_rep": false,
      • "eloqua_contact_captured_by_rep": false,
      • "meetings": [
        • {
          • "offer_sent_at": "2019-08-24T14:15:22Z",
          • "booked_user_id": "gcypWVVAM2rYrfP6utuFbYnzf59yRTps5se9e"
          }
        ],
      • "calls": [
        • {
          • "started_at": "2019-08-24T14:15:22Z",
          • "ended_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "messages": [
        • {
          • "sent_at": "2019-08-24T14:15:22Z",
          • "visitor_id": "gct6jvH379QyHnoX3x83pgq3ktk5d1KUCKvbq",
          • "bot_id": null,
          • "user_id": null,
          • "text": "hello! I'm a human"
          }
        ]
      }
    ],
  • "meta": {
    • "ending_cursor": "string",
    • "has_more": true
    }
}