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>",
"statusId": "<string>",
"priority": "<string>",
"priorityId": "<string>",
"storyPoints": 123,
"account": "<string>",
"teamId": "<string>",
"teamName": "<string>",
"teamIdentifier": "<string>",
"subTeamId": "<string>",
"subTeamName": "<string>",
"subTeamIdentifier": "<string>",
"isPrivate": true,
"typeId": "<string>",
"type": "<string>",
"assignedAgent": "<string>",
"assignedAgentId": "<string>",
"assignedAgentEmail": "<string>",
"assignedAgentAvatar": "<string>",
"requestorEmail": "<string>",
"customerContactId": "<string>",
"customerContactFirstName": "<string>",
"customerContactLastName": "<string>",
"customerContactEmail": "<string>",
"submitterEmail": "<string>",
"customFieldValues": [
"<string>"
],
"deletedAt": "<string>",
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"formId": "<string>",
"aiGeneratedTitle": "<string>",
"aiGeneratedSummary": "<string>",
"sentiment": "<string>",
"sentimentId": "<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>",
"uid": "<string>",
"metadata": "<string>",
"organizationId": "<string>",
"organizationUid": "<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>",
"teamUid": "<string>",
"subTeamUid": "<string>",
"assignedAgentName": "<string>",
"statusName": "<string>",
"statusUid": "<string>",
"priorityUid": "<string>",
"priorityName": "<string>",
"typeName": "<string>",
"typeUid": "<string>",
"typeIcon": "<string>",
"typeColor": "<string>",
"isEscalated": true,
"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>",
"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>",
"statusId": "<string>",
"priority": "<string>",
"priorityId": "<string>",
"storyPoints": 123,
"account": "<string>",
"teamId": "<string>",
"teamName": "<string>",
"teamIdentifier": "<string>",
"subTeamId": "<string>",
"subTeamName": "<string>",
"subTeamIdentifier": "<string>",
"isPrivate": true,
"typeId": "<string>",
"type": "<string>",
"assignedAgent": "<string>",
"assignedAgentId": "<string>",
"assignedAgentEmail": "<string>",
"assignedAgentAvatar": "<string>",
"requestorEmail": "<string>",
"customerContactId": "<string>",
"customerContactFirstName": "<string>",
"customerContactLastName": "<string>",
"customerContactEmail": "<string>",
"submitterEmail": "<string>",
"customFieldValues": [
"<string>"
],
"deletedAt": "<string>",
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"formId": "<string>",
"aiGeneratedTitle": "<string>",
"aiGeneratedSummary": "<string>",
"sentiment": "<string>",
"sentimentId": "<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>",
"uid": "<string>",
"metadata": "<string>",
"organizationId": "<string>",
"organizationUid": "<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>",
"teamUid": "<string>",
"subTeamUid": "<string>",
"assignedAgentName": "<string>",
"statusName": "<string>",
"statusUid": "<string>",
"priorityUid": "<string>",
"priorityName": "<string>",
"typeName": "<string>",
"typeUid": "<string>",
"typeIcon": "<string>",
"typeColor": "<string>",
"isEscalated": true,
"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>",
"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"
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
The response is of type object
.