curl --request GET \
--url https://platform.thena.ai/v1/search/{collection} \
--header 'x-api-key: <api-key>'{
"result": {
"facet_counts": [
{}
],
"found": 123,
"hits": [
{
"document": {
"id": "<string>",
"ticketIdentifier": "<string>",
"title": "<string>",
"ticketId": 123,
"description": "<string>",
"source": "<string>",
"accountId": "<string>",
"status": "<string>",
"priority": "<string>",
"storyPoints": 123,
"account": "<string>",
"teamId": "<string>",
"teamName": "<string>",
"subTeamName": "<string>",
"subTeamIdentifier": "<string>",
"isPrivate": true,
"type": "<string>",
"assignedAgent": "<string>",
"assignedAgentAvatar": "<string>",
"requestorEmail": "<string>",
"customerContactFirstName": "<string>",
"customerContactLastName": "<string>",
"submitterEmail": "<string>",
"customFieldValues": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"sentiment": "<string>",
"teamIcon": "<string>",
"teamColor": "<string>",
"teamOrganizationId": "<string>",
"teamParentTeamId": "<string>",
"teamDescription": "<string>",
"teamConfigurationId": "<string>",
"teamTeamOwnerId": "<string>",
"teamIsActive": true,
"teamIsPrivate": true,
"teamCreatedAt": "<string>",
"teamUpdatedAt": "<string>",
"teamDeletedAt": "<string>",
"teamArchivedAt": "<string>",
"subTeamIcon": "<string>",
"subTeamColor": "<string>",
"subTeamOrganizationId": "<string>",
"subTeamParentTeamId": "<string>",
"subTeamDescription": "<string>",
"subTeamConfigurationId": "<string>",
"subTeamTeamOwnerId": "<string>",
"subTeamIsActive": true,
"subTeamIsPrivate": true,
"subTeamCreatedAt": "<string>",
"subTeamUpdatedAt": "<string>",
"subTeamDeletedAt": "<string>",
"subTeamArchivedAt": "<string>",
"lastCustomerComment": "<string>",
"lastVendorComment": "<string>",
"lastComment": "<string>",
"uid": "<string>",
"organizationId": "<string>",
"organizationUid": "<string>",
"teamUid": "<string>",
"statusId": "<string>",
"priorityId": "<string>",
"teamIdentifier": "<string>",
"subTeamId": "<string>",
"typeId": "<string>",
"assignedAgentId": "<string>",
"assignedAgentEmail": "<string>",
"customerContactId": "<string>",
"customerContactEmail": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"formId": "<string>",
"aiGeneratedTitle": "<string>",
"aiGeneratedSummary": "<string>",
"sentimentId": "<string>",
"closedAt": "<string>",
"closedBy": "<string>",
"closedById": "<string>",
"closedByEmail": "<string>",
"isEscalated": true,
"metadata": "<string>",
"formUid": "<string>",
"formName": "<string>",
"formCreatedAt": "<string>",
"formUpdatedAt": "<string>",
"formOrder": "<string>",
"formDeletedAt": "<string>",
"formCreatedBy": "<string>",
"formTeamId": "<string>",
"formType": "<string>",
"formDefault": "<string>",
"accountPrimaryDomain": "<string>",
"accountWebsite": "<string>",
"accountAnnualRevenue": "<string>",
"accountEmployees": "<string>",
"accountOwnerId": "<string>",
"accountOwnerEmail": "<string>",
"accountOwnerName": "<string>",
"accountOwnerUserType": "<string>",
"accountOwnerStatus": "<string>",
"accountOwnerTimezone": "<string>",
"accountOwnerAvatarUrl": "<string>",
"subTeamUid": "<string>",
"assignedAgentName": "<string>",
"statusName": "<string>",
"statusUid": "<string>",
"priorityUid": "<string>",
"priorityName": "<string>",
"typeName": "<string>",
"typeUid": "<string>",
"typeIcon": "<string>",
"typeColor": "<string>",
"isDraft": true,
"sentimentUid": "<string>",
"sentimentName": "<string>",
"dueDate": "<string>",
"contactEmail": "<string>",
"contactName": "<string>",
"contactPhone": "<string>",
"contactAvatarUrl": "<string>",
"ticketRelationshipsAsSource": [
"<string>"
],
"ticketRelationshipsAsTarget": [
"<string>"
],
"slaTotalResolutionTimeStatus": "<string>",
"slaTotalResolutionTimeScheduledAt": "<string>",
"slaTotalResolutionTimeBreachedAt": "<string>",
"slaTotalResolutionTimeAchievedAt": "<string>",
"slaTotalResolutionTimePausedAt": "<string>",
"slaTotalResolutionTimeResumedAt": "<string>",
"slaTotalResolutionTimeCancelledAt": "<string>",
"slaTotalResolutionTimeCreatedAt": "<string>",
"slaTotalResolutionTimeDurationToBreachMinutes": "<string>",
"slaTotalResolutionTimePausedDurationMinutes": "<string>",
"slaTotalResolutionTimeNextAttemptAt": "<string>",
"slaFirstTimeResponseStatus": "<string>",
"slaFirstTimeResponseScheduledAt": "<string>",
"slaFirstTimeResponseBreachedAt": "<string>",
"slaFirstTimeResponseAchievedAt": "<string>",
"slaFirstTimeResponsePausedAt": "<string>",
"slaFirstTimeResponseResumedAt": "<string>",
"slaFirstTimeResponseCancelledAt": "<string>",
"slaFirstTimeResponseDurationToBreachMinutes": "<string>",
"slaFirstTimeResponsePausedDurationMinutes": "<string>",
"slaFirstTimeResponseNextAttemptAt": "<string>",
"slaNextTimeResponseStatus": "<string>",
"slaNextTimeResponseScheduledAt": "<string>",
"slaNextTimeResponseBreachedAt": "<string>",
"slaNextTimeResponseAchievedAt": "<string>",
"slaNextTimeResponsePausedAt": "<string>",
"slaNextTimeResponseResumedAt": "<string>",
"slaNextTimeResponseCancelledAt": "<string>",
"slaNextTimeResponseDurationToBreachMinutes": "<string>",
"slaNextTimeResponsePausedDurationMinutes": "<string>",
"slaNextTimeResponseNextAttemptAt": "<string>",
"slaUpdateTimeStatus": "<string>",
"slaUpdateTimeScheduledAt": "<string>",
"slaUpdateTimeBreachedAt": "<string>",
"slaUpdateTimeAchievedAt": "<string>",
"slaUpdateTimePausedAt": "<string>",
"slaUpdateTimeResumedAt": "<string>",
"slaUpdateTimeCancelledAt": "<string>",
"slaUpdateTimeDurationToBreachMinutes": "<string>",
"slaUpdateTimePausedDurationMinutes": "<string>",
"slaUpdateTimeNextAttemptAt": "<string>",
"accountHealth": "<string>",
"accountSource": "<string>",
"isProactive": true,
"proactiveChannels": [
"<string>"
],
"accountIsActive": true,
"accountIndustry": "<string>",
"accountClassification": "<string>",
"accountStatus": "<string>",
"accountUid": "<string>",
"accountLogo": "<string>",
"accountOwnerUid": "<string>",
"customFieldDeletedAt": "<string>",
"tags": {
"values": [
{
"color": "<string>",
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"id": "<string>",
"is_active": "<string>",
"name": "<string>",
"organization_id": "<string>",
"tagType": "<string>",
"team_id": "<string>",
"uid": "<string>",
"updated_at": "<string>"
}
]
},
"assignedAgentUid": "<string>",
"assignedAgentAvatarUrl": "<string>",
"customerContactUid": "<string>",
"customerContactName": "<string>",
"accountHealthUid": "<string>",
"accountIndustryUid": "<string>",
"accountClassificationUid": "<string>",
"accountStatusUid": "<string>",
"accountHealthValue": "<string>",
"accountIndustryValue": "<string>",
"accountClassificationValue": "<string>",
"accountStatusValue": "<string>",
"slaTotalResolutionTimeComplianceState": "<string>",
"slaFirstTimeResponseComplianceState": "<string>",
"slaNextTimeResponseComplianceState": "<string>",
"slaUpdateComplianceState": "<string>",
"accountCustomFields": [
"<string>"
],
"ticketCustomFieldValues": [
"<string>"
],
"accountSecondaryDomain": "<string>",
"accountBillingAddress": "<string>",
"accountShippingAddress": "<string>",
"csatRatingValue": "<string>",
"csatCommentText": "<string>",
"csatCompletedAt": "<string>",
"csatMappingStatus": "<string>",
"csatSamplingStatus": "<string>",
"csatFeedbackType": "<string>",
"csatSurveyConfigRatingScale": 123,
"csatDeliveryDetailsRecipient": "<string>",
"csatDeliveryDetailsLastAttemptAt": "<string>",
"csatDeliveryDetailsDeliveryAttempts": 123,
"parentStatusUid": "<string>",
"parentStatusName": "<string>",
"slaFirstTimeResponseCreatedAt": "<string>",
"slaNextTimeResponseCreatedAt": "<string>",
"slaUpdateTimeCreatedAt": "<string>"
}
}
],
"page": 123,
"request_params": {},
"search_cutoff": true
}
}Search for tickets, accounts, comments, help center, users, organization and teams
curl --request GET \
--url https://platform.thena.ai/v1/search/{collection} \
--header 'x-api-key: <api-key>'{
"result": {
"facet_counts": [
{}
],
"found": 123,
"hits": [
{
"document": {
"id": "<string>",
"ticketIdentifier": "<string>",
"title": "<string>",
"ticketId": 123,
"description": "<string>",
"source": "<string>",
"accountId": "<string>",
"status": "<string>",
"priority": "<string>",
"storyPoints": 123,
"account": "<string>",
"teamId": "<string>",
"teamName": "<string>",
"subTeamName": "<string>",
"subTeamIdentifier": "<string>",
"isPrivate": true,
"type": "<string>",
"assignedAgent": "<string>",
"assignedAgentAvatar": "<string>",
"requestorEmail": "<string>",
"customerContactFirstName": "<string>",
"customerContactLastName": "<string>",
"submitterEmail": "<string>",
"customFieldValues": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"sentiment": "<string>",
"teamIcon": "<string>",
"teamColor": "<string>",
"teamOrganizationId": "<string>",
"teamParentTeamId": "<string>",
"teamDescription": "<string>",
"teamConfigurationId": "<string>",
"teamTeamOwnerId": "<string>",
"teamIsActive": true,
"teamIsPrivate": true,
"teamCreatedAt": "<string>",
"teamUpdatedAt": "<string>",
"teamDeletedAt": "<string>",
"teamArchivedAt": "<string>",
"subTeamIcon": "<string>",
"subTeamColor": "<string>",
"subTeamOrganizationId": "<string>",
"subTeamParentTeamId": "<string>",
"subTeamDescription": "<string>",
"subTeamConfigurationId": "<string>",
"subTeamTeamOwnerId": "<string>",
"subTeamIsActive": true,
"subTeamIsPrivate": true,
"subTeamCreatedAt": "<string>",
"subTeamUpdatedAt": "<string>",
"subTeamDeletedAt": "<string>",
"subTeamArchivedAt": "<string>",
"lastCustomerComment": "<string>",
"lastVendorComment": "<string>",
"lastComment": "<string>",
"uid": "<string>",
"organizationId": "<string>",
"organizationUid": "<string>",
"teamUid": "<string>",
"statusId": "<string>",
"priorityId": "<string>",
"teamIdentifier": "<string>",
"subTeamId": "<string>",
"typeId": "<string>",
"assignedAgentId": "<string>",
"assignedAgentEmail": "<string>",
"customerContactId": "<string>",
"customerContactEmail": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"formId": "<string>",
"aiGeneratedTitle": "<string>",
"aiGeneratedSummary": "<string>",
"sentimentId": "<string>",
"closedAt": "<string>",
"closedBy": "<string>",
"closedById": "<string>",
"closedByEmail": "<string>",
"isEscalated": true,
"metadata": "<string>",
"formUid": "<string>",
"formName": "<string>",
"formCreatedAt": "<string>",
"formUpdatedAt": "<string>",
"formOrder": "<string>",
"formDeletedAt": "<string>",
"formCreatedBy": "<string>",
"formTeamId": "<string>",
"formType": "<string>",
"formDefault": "<string>",
"accountPrimaryDomain": "<string>",
"accountWebsite": "<string>",
"accountAnnualRevenue": "<string>",
"accountEmployees": "<string>",
"accountOwnerId": "<string>",
"accountOwnerEmail": "<string>",
"accountOwnerName": "<string>",
"accountOwnerUserType": "<string>",
"accountOwnerStatus": "<string>",
"accountOwnerTimezone": "<string>",
"accountOwnerAvatarUrl": "<string>",
"subTeamUid": "<string>",
"assignedAgentName": "<string>",
"statusName": "<string>",
"statusUid": "<string>",
"priorityUid": "<string>",
"priorityName": "<string>",
"typeName": "<string>",
"typeUid": "<string>",
"typeIcon": "<string>",
"typeColor": "<string>",
"isDraft": true,
"sentimentUid": "<string>",
"sentimentName": "<string>",
"dueDate": "<string>",
"contactEmail": "<string>",
"contactName": "<string>",
"contactPhone": "<string>",
"contactAvatarUrl": "<string>",
"ticketRelationshipsAsSource": [
"<string>"
],
"ticketRelationshipsAsTarget": [
"<string>"
],
"slaTotalResolutionTimeStatus": "<string>",
"slaTotalResolutionTimeScheduledAt": "<string>",
"slaTotalResolutionTimeBreachedAt": "<string>",
"slaTotalResolutionTimeAchievedAt": "<string>",
"slaTotalResolutionTimePausedAt": "<string>",
"slaTotalResolutionTimeResumedAt": "<string>",
"slaTotalResolutionTimeCancelledAt": "<string>",
"slaTotalResolutionTimeCreatedAt": "<string>",
"slaTotalResolutionTimeDurationToBreachMinutes": "<string>",
"slaTotalResolutionTimePausedDurationMinutes": "<string>",
"slaTotalResolutionTimeNextAttemptAt": "<string>",
"slaFirstTimeResponseStatus": "<string>",
"slaFirstTimeResponseScheduledAt": "<string>",
"slaFirstTimeResponseBreachedAt": "<string>",
"slaFirstTimeResponseAchievedAt": "<string>",
"slaFirstTimeResponsePausedAt": "<string>",
"slaFirstTimeResponseResumedAt": "<string>",
"slaFirstTimeResponseCancelledAt": "<string>",
"slaFirstTimeResponseDurationToBreachMinutes": "<string>",
"slaFirstTimeResponsePausedDurationMinutes": "<string>",
"slaFirstTimeResponseNextAttemptAt": "<string>",
"slaNextTimeResponseStatus": "<string>",
"slaNextTimeResponseScheduledAt": "<string>",
"slaNextTimeResponseBreachedAt": "<string>",
"slaNextTimeResponseAchievedAt": "<string>",
"slaNextTimeResponsePausedAt": "<string>",
"slaNextTimeResponseResumedAt": "<string>",
"slaNextTimeResponseCancelledAt": "<string>",
"slaNextTimeResponseDurationToBreachMinutes": "<string>",
"slaNextTimeResponsePausedDurationMinutes": "<string>",
"slaNextTimeResponseNextAttemptAt": "<string>",
"slaUpdateTimeStatus": "<string>",
"slaUpdateTimeScheduledAt": "<string>",
"slaUpdateTimeBreachedAt": "<string>",
"slaUpdateTimeAchievedAt": "<string>",
"slaUpdateTimePausedAt": "<string>",
"slaUpdateTimeResumedAt": "<string>",
"slaUpdateTimeCancelledAt": "<string>",
"slaUpdateTimeDurationToBreachMinutes": "<string>",
"slaUpdateTimePausedDurationMinutes": "<string>",
"slaUpdateTimeNextAttemptAt": "<string>",
"accountHealth": "<string>",
"accountSource": "<string>",
"isProactive": true,
"proactiveChannels": [
"<string>"
],
"accountIsActive": true,
"accountIndustry": "<string>",
"accountClassification": "<string>",
"accountStatus": "<string>",
"accountUid": "<string>",
"accountLogo": "<string>",
"accountOwnerUid": "<string>",
"customFieldDeletedAt": "<string>",
"tags": {
"values": [
{
"color": "<string>",
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"id": "<string>",
"is_active": "<string>",
"name": "<string>",
"organization_id": "<string>",
"tagType": "<string>",
"team_id": "<string>",
"uid": "<string>",
"updated_at": "<string>"
}
]
},
"assignedAgentUid": "<string>",
"assignedAgentAvatarUrl": "<string>",
"customerContactUid": "<string>",
"customerContactName": "<string>",
"accountHealthUid": "<string>",
"accountIndustryUid": "<string>",
"accountClassificationUid": "<string>",
"accountStatusUid": "<string>",
"accountHealthValue": "<string>",
"accountIndustryValue": "<string>",
"accountClassificationValue": "<string>",
"accountStatusValue": "<string>",
"slaTotalResolutionTimeComplianceState": "<string>",
"slaFirstTimeResponseComplianceState": "<string>",
"slaNextTimeResponseComplianceState": "<string>",
"slaUpdateComplianceState": "<string>",
"accountCustomFields": [
"<string>"
],
"ticketCustomFieldValues": [
"<string>"
],
"accountSecondaryDomain": "<string>",
"accountBillingAddress": "<string>",
"accountShippingAddress": "<string>",
"csatRatingValue": "<string>",
"csatCommentText": "<string>",
"csatCompletedAt": "<string>",
"csatMappingStatus": "<string>",
"csatSamplingStatus": "<string>",
"csatFeedbackType": "<string>",
"csatSurveyConfigRatingScale": 123,
"csatDeliveryDetailsRecipient": "<string>",
"csatDeliveryDetailsLastAttemptAt": "<string>",
"csatDeliveryDetailsDeliveryAttempts": 123,
"parentStatusUid": "<string>",
"parentStatusName": "<string>",
"slaFirstTimeResponseCreatedAt": "<string>",
"slaNextTimeResponseCreatedAt": "<string>",
"slaUpdateTimeCreatedAt": "<string>"
}
}
],
"page": 123,
"request_params": {},
"search_cutoff": true
}
}Enter your API key
The collection to search (tickets, comments, accounts, customer_contacts, help_center, users, organization, teams)
tickets, comments, accounts, customer_contacts, help_center, users, organization, teams Search mode - 'primary' for main search, 'fallback' for secondary search
primary, fallback The search query
"*"
Fields to query by (comma separated)
"title,description"
Enable streaming of paginated results
false
Filter by expression
"priorityName:=medium&&statusName:=resolved"
Sort by expression
Facet by fields (comma separated)
Page number
Results per page
"10"
Cursor for pagination
"01HQXYZ123456789"
Navigation direction for cursor pagination
forward, backward, first, last "forward"
Group by fields (comma separated)
Group limit
Fields to include in the response (comma separated)
"uid,title,statusName,createdAt,updatedAt,priorityName,ticketIdentifier"
Exclude fields (comma separated)
Search result
Show child attributes
Show child attributes
Show child attributes
The unique identifier of the ticket
The unique identifier of the ticket
The title of the ticket
The ticket ID of the ticket
The description of the ticket
The source of the ticket
The account ID of the ticket
The status of the ticket
The priority of the ticket
The story points of the ticket
The account of the ticket
The team ID of the ticket
The name of the team of the ticket
The name of the sub team of the ticket
The identifier of the sub team of the ticket
Whether the ticket is private
The name of the type of the ticket
The assigned agent of the ticket
The assigned agent avatar of the ticket
The requestor email of the ticket
The customer contact first name of the ticket
The customer contact last name of the ticket
The submitter email of the ticket
The custom field values
The created at date of the ticket
The updated at date of the ticket
The sentiment of the ticket
The team icon of the ticket
The team color of the ticket
The team organization ID of the ticket
The team parent team ID of the ticket
The team description of the ticket
The team configuration ID of the ticket
The team team owner ID of the ticket
The team is active of the ticket
The team is private of the ticket
The team created at of the ticket
The team updated at of the ticket
The team deleted at of the ticket
The team archived at of the ticket
The sub team icon of the ticket
The sub team color of the ticket
The sub team organization ID of the ticket
The sub team parent team ID of the ticket
The sub team description of the ticket
The sub team configuration ID of the ticket
The sub team team owner ID of the ticket
The sub team is active of the ticket
The sub team is private of the ticket
The sub team created at of the ticket
The sub team updated at of the ticket
The sub team deleted at of the ticket
The sub team archived at of the ticket
The last customer comment timestamp
The last vendor comment timestamp
The last comment timestamp (max of lastCustomerComment and lastVendorComment)
The status ID of the ticket
The priority ID of the ticket
The identifier of the team of the ticket
The sub team ID of the ticket
The type ID of the ticket
The assigned agent ID of the ticket
The assigned agent email of the ticket
The customer contact ID of the ticket
The customer contact email of the ticket
The deleted at date of the ticket
The archived at date of the ticket
The form ID of the ticket
The AI generated title of the ticket
The AI generated summary of the ticket
The sentiment ID of the ticket
The closed at date of the ticket
The display name of the user who closed the ticket
The ID of the user who closed the ticket
The email of the user who closed the ticket
Whether the ticket is escalated
Show child attributes
Show child attributes