- HealthEntity
Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.
{ "url": "Example String", "name": "Example String", "type": "Example String", "size": 40, "duration": 40, "locationData": { "__typename": "LocationData" } }
{ "name": "Example String", "label": "Example String", "order": 40 }
Payload for converted_to_card action.
{ "cardType": "Example String", "performedBy": "Example String", "performedByUser": { "__typename": "User" } }
An email address with optional display name.
Display name (e.g. 'John Doe').
Email address (e.g. 'john@example.com').
{ "name": "Example String", "address": "Example String" }
Email-specific attachment metadata.
Original filename.
MIME type.
File size in bytes.
Content-ID for inline/embedded images.
Server-side storage ID for download.
{ "filename": "Example String", "mimeType": "Example String", "size": 40, "contentId": "Example String", "attachmentId": "Example String" }
{ "entity_type": "Example String", "id": "Example String", "can_send_message": "Example String", "additional_info": [ "Example String" ] }
Available custom field definitions for inbox entities.
{ "customer": [ { "__typename": "Field" } ], "conversation": [ { "__typename": "Field" } ], "device": [ { "__typename": "Field" } ] }
A knowledge base article containing help content, documentation, or guides. Articles belong to categories within topics and support rich content, attachments, and reactions.
Unique code identifier for programmatic access.
The article title.
Brief summary or excerpt of the article content.
Full article content (HTML).
Publication status: 'draft', 'publish', or 'scheduled'.
Whether this article is only visible to team members.
Available emoji reaction types for this article.
Count of each reaction type received.
User ID of the article creator.
The resolved user who created this article.
When this article was created.
User ID of the last modifier.
When this article was last modified.
The topic this article belongs to.
The category this article belongs to.
Total number of times this article has been viewed.
File attachments included with this article.
Featured image for the article.
PDF attachment with extracted page images.
User ID of who published this article.
The resolved user who published this article.
Scheduled publication date (for status 'scheduled').
Forms embedded in this article.
{ "_id": "Example String", "code": "Example String", "title": "Example String", "summary": "Example String", "content": "Example String", "status": "Example String", "isPrivate": true, "reactionChoices": [ "Example String" ], "reactionCounts": "Example Custom Scalar", "createdBy": "Example String", "createdUser": { "__typename": "User" }, "createdDate": "Example Custom Scalar", "modifiedBy": "Example String", "modifiedDate": "Example Custom Scalar", "topicId": "Example String", "categoryId": "Example String", "viewCount": 40, "attachments": [ { "__typename": "Attachment" } ], "image": { "__typename": "Attachment" }, "pdfAttachment": { "__typename": "PdfAttachment" }, "publishedUserId": "Example String", "publishedUser": { "__typename": "User" }, "scheduledDate": "Example Custom Scalar", "forms": [ { "__typename": "FormCode" } ] }
Paginated list of knowledge base articles.
The list of articles for the current page.
Pagination metadata.
{ "data": [ { "__typename": "KnowledgeBaseArticle" } ], "pagination": { "__typename": "PaginationInfo" } }
Paginated list of knowledge base categories.
The list of categories for the current page.
Pagination metadata.
{ "data": [ { "__typename": "KnowledgeBaseCategory" } ], "pagination": { "__typename": "PaginationInfo" } }
A category that groups related knowledge base articles together. Categories can be nested under parent categories for hierarchical organization.
Unique code identifier for programmatic access.
The category title.
Description of what this category covers.
Articles in this category, optionally filtered by status.
Icon identifier for the category.
User ID of the category creator.
When this category was created.
User ID of the last modifier.
When this category was last modified.
Parent category ID for nested categorization.
The first topic this category belongs to.
Users who have authored articles in this category.
Count of articles in this category, optionally filtered by status.
Total article count in this category.
{ "_id": "Example String", "code": "Example String", "title": "Example String", "description": "Example String", "articles": [ { "__typename": "KnowledgeBaseArticle" } ], "icon": "Example String", "createdBy": "Example String", "createdDate": "Example Custom Scalar", "modifiedBy": "Example String", "modifiedDate": "Example Custom Scalar", "parentCategoryId": "Example String", "firstTopic": { "__typename": "KnowledgeBaseTopic" }, "authors": [ { "__typename": "User" } ], "numOfArticles": 40, "countArticles": 40 }