Skip to content
OnCoreDocs
Conversations

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 field

List conversations

Try it in the API Explorer

Example request

Terminal
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.

Authorizationstringrequired

API 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)optional

Required when authenticating with an organization key: it selects the tenant the request acts on. Omit with tenant keys.

Request

Query parameters

limitstringoptional

Maximum number of items to return

offsetstringoptional

Number of items to skip from the beginning

assistantIdstringoptional

Filter by assistant ID (UUID)

channelstringoptional

Filter by channel: web, sms, or whatsapp

statusstringoptional

Filter by conversation status

dateFromstringoptional

Filter conversations started at or after this ISO datetime

dateTostringoptional

Filter conversations started at or before this ISO datetime

sortBystringoptional

Sort by field: startedAt (default) or createdAt

searchstringoptional

Free-text search across customer identifier

Responses

200
successbooleanrequired

true on every 2xx

dataobjectoptional

The result

Show 2 child properties
conversationsobject[]required

List of conversations

Show 18 item properties
idstringrequired
conversationIdstring | nullrequired
assistantIdstring | nullrequired
assistantNamestring | nullrequired
channelstring | nullrequired
customerIdentifierstring | nullrequired
statusstring | nullrequired
startedAtstring (date-time) | string (date) | number | nullrequired
closedAtstring (date-time) | string (date) | number | nullrequired
lastInboundAtstring (date-time) | string (date) | number | nulloptional
lastOutboundAtstring (date-time) | string (date) | number | nulloptional
transcriptstring | nulloptional
summarystring | nulloptional
messagesany | nulloptional
analysisany | nulloptional
endedReasonstring | nullrequired
costnumber | nulloptional
costBreakdownany | nulloptional
totalnumberrequired

Total number of conversations found

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

400The request is invalid. `details` lists each field that failed
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

A parameter or body field broke a rule

Allowed values:"VALIDATION_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobject[]optional

One entry per field that failed

Show 2 item properties
fieldstringrequired

The offending field

messagestringrequired

The rule it broke

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

401Missing or invalid credentials
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

No valid credentials

Allowed values:"UNAUTHORIZED"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

403The credentials are valid but may not use this route
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

The credentials may not use this route

Allowed values:"FORBIDDEN"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

404Not found, or outside the caller's scope
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An id names nothing the caller can see

Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

500An unexpected server error
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An unexpected server failure

Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested