Get Intent Data

Get intent data for specified companies and topics.

Endpoint

GET https://api.intentgpt.ai/intent

Headers

x-api-key
string
required
Your API key

Query Parameters

offset
integer
Starting point for returned rows, useful for pagination
companies
string
Comma-separated list of company domains (e.g., “salesforce.com,oracle.com”)
topics
string
One or more topics to filter intent data (e.g., “marketing”, “sales”)
intent_levels
string
Filter by intent level: ONFIRE, HOT, WARM, COLD

Response

success
boolean
Indicates if the request was successful
data
array
Array of intent data objects
data[].company
string
Company domain
data[].intent_level
string
Intent level (ONFIRE, HOT, WARM, COLD)
data[].topic
string
Topic associated with the intent
data[].timestamp
string
ISO 8601 timestamp of when the intent was detected

Examples

curl -X GET "https://api.intentgpt.ai/intent" \
-H "x-api-key: p1rOh.J8jSgXbELsNP9j.zEc0LlopZGq" \
-G --data-urlencode "companies=salesforce.com,oracle.com" \
--data-urlencode "topics=marketing" \
--data-urlencode "intent_levels=HOT"

Error Codes

401
object
Invalid or missing API key
400
object
Invalid request parameters
404
object
No data found for the specified filters
500
object
Internal server error

Notes

  • The API returns up to 1000 rows per request
  • Use the offset parameter for pagination when dealing with large datasets
  • All timestamps are in UTC
  • Intent levels indicate the strength of buying signals:
    • ONFIRE: Immediate buying signals
    • HOT: Strong interest
    • WARM: Moderate interest
    • COLD: Minimal interest