GEThttps://core-api.heysadie.ai/conversations
limit offset assistantId channel status dateFrom dateTo sortBy search success data conversations id conversationId assistantName customerIdentifier startedAt closedAt lastInboundAt lastOutboundAt transcript summary messages analysis endedReason cost costBreakdown total metadata timestamp version path error code message details fieldList conversations
Try it in the API ExplorerExample request
curl "https://core-api.heysadie.ai/conversations?limit=10&offset=0" \
-H "Authorization: ApiKey YOUR_API_KEY"Authentication
Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.
AuthorizationstringrequiredAPI key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.
X-Tenant-Idstring (uuid)optionalRequired when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.
Request
Query parameters
limitstringoptionalMaximum number of items to return
offsetstringoptionalNumber of items to skip from the beginning
assistantIdstringoptionalFilter by assistant ID (UUID)
channelstringoptionalFilter by channel: web, sms, or whatsapp
statusstringoptionalFilter by conversation status
dateFromstringoptionalFilter conversations started at or after this ISO datetime
dateTostringoptionalFilter conversations started at or before this ISO datetime
sortBystringoptionalSort by field: startedAt (default) or createdAt
searchstringoptionalFree-text search across customer identifier
Responses
successbooleanrequireddataobjectoptionalShow 2 child properties
conversationsobject[]requiredList of conversations
Show 18 item properties
idstringrequiredconversationIdstring | nullrequiredassistantIdstring | nullrequiredassistantNamestring | nullrequiredchannelstring | nullrequiredcustomerIdentifierstring | nullrequiredstatusstring | nullrequiredstartedAtstring (date-time) | string (date) | number | nullrequiredclosedAtstring (date-time) | string (date) | number | nullrequiredlastInboundAtstring (date-time) | string (date) | number | nulloptionallastOutboundAtstring (date-time) | string (date) | number | nulloptionaltranscriptstring | nulloptionalsummarystring | nulloptionalmessagesany | nulloptionalanalysisany | nulloptionalendedReasonstring | nullrequiredcostnumber | nulloptionalcostBreakdownany | nulloptionaltotalnumberrequiredTotal number of conversations found
metadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional400
successbooleanrequirederrorobjectoptionalShow 3 child properties
codeenumrequired"VALIDATION_ERROR"messagestringrequireddetailsobject[]optionalShow 2 item properties
fieldstringrequiredmessagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional401
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequired"UNAUTHORIZED"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional403
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequired"FORBIDDEN"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional404
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequired"RESOURCE_NOT_FOUND"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional500
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequired"INTERNAL_SERVER_ERROR"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional