- LocationOption
Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.
Results from a knowledge base semantic search query.
The original search query.
Total number of matching results.
The search result hits, ordered by relevance.
Source citations for the results.
{ "query": "Example String", "totalResults": 40, "results": [ { "__typename": "KnowledgeBaseSearchHit" } ], "citations": [ "Example Custom Scalar" ] }
A knowledge base topic — the top-level organizational unit. Topics are associated with a brand and contain categories of articles. They can be styled with custom colors and background images.
Unique code identifier for programmatic access.
The topic title.
Description of the topic.
Categories within this topic.
URL of the background image for the topic page.
ISO language code for the topic content (e.g. 'en', 'ar').
User ID of the topic creator.
When this topic was created.
User ID of the last modifier.
When this topic was last modified.
Top-level parent categories within this topic.
{ "_id": "Example String", "code": "Example String", "title": "Example String", "description": "Example String", "categories": [ { "__typename": "KnowledgeBaseCategory" } ], "workspace": { "__typename": "Workspace" }, "color": "Example String", "backgroundImage": "Example String", "languageCode": "Example String", "createdBy": "Example String", "createdDate": "Example Custom Scalar", "modifiedBy": "Example String", "modifiedDate": "Example Custom Scalar", "parentCategories": [ { "__typename": "KnowledgeBaseParentCategory" } ] }
Paginated list of knowledge base topics.
The list of topics for the current page.
Pagination metadata.
{ "data": [ { "__typename": "KnowledgeBaseTopic" } ], "pagination": { "__typename": "PaginationInfo" } }
Single entry in a lead's stage-change history.
{ "stageCode": "Example String", "at": "Example Custom Scalar", "byUserId": "Example String", "note": "Example String" }
{ "latitude": 40, "longitude": 40, "name": "Example String", "address": "Example String" }
{ "lat": 40, "lng": 40, "description": "Example String" }
{ "fieldId": "Example String", "logicOperator": "Example String", "logicValue": "Example Custom Scalar" }
Threading and forwarding context for a message.
The message ID this is replying to.
Whether this message was forwarded.
User IDs mentioned in this message.
{ "replyTo": "Example String", "isForwarded": true, "mentions": [ "Example String" ] }
Delivery status tracking for a message.
Delivery status: 'sending', 'sent', 'delivered', 'seen', 'failed'.
Error message if delivery failed.
{ "status": "Example String", "error": "Example String" }
A single edit in a message's edit history.
The previous content before this edit.
When the edit was made.
{ "content": "Example String", "editedAt": "Example Custom Scalar" }
Email-specific envelope and body data.
Email subject line.
Integration ID this email belongs to.
Sender address(es).
To recipients.
CC recipients.
BCC recipients (only visible to sender).
RFC 5322 References header chain for threading.
Sanitized HTML body.
Plain-text fallback body.
Short preview snippet.
Email-native attachment metadata.
Extracted new content (stripped of quoted/replied text).
The quoted/replied portion of the email body.
Detected email signature block.
{ "subject": "Example String", "integrationId": "Example String", "from": [ { "__typename": "EmailAddress" } ], "to": [ { "__typename": "EmailAddress" } ], "cc": [ { "__typename": "EmailAddress" } ], "bcc": [ { "__typename": "EmailAddress" } ], "references": [ "Example String" ], "htmlBody": "Example String", "textBody": "Example String", "snippet": "Example String", "attachments": [ { "__typename": "EmailAttachment" } ], "newContent": "Example String", "quotedContent": "Example String", "signature": "Example String" }