> ## Documentation Index > Fetch the complete documentation index at: https://docs.thena.ai/llms.txt > Use this file to discover all available pages before exploring further. # Entity search > Search for tickets, accounts, comments, help center, users, organization and teams ## OpenAPI ````yaml get /v1/search/{collection} openapi: 3.0.0 info: title: Thena Platform description: The Thena Platform API description version: 1.0.0 contact: {} servers: - url: https://platform.thena.ai description: Platform - url: http://localhost:8000 description: Local security: - ApiKey: [] tags: [] paths: /v1/search/{collection}: get: tags: - Search summary: Entity search description: >- Search for tickets, accounts, comments, help center, users, organization and teams operationId: SearchController_search parameters: - name: collection required: true in: path description: >- The collection to search (tickets, comments, accounts, customer_contacts, help_center, users, organization, teams) schema: enum: - tickets - comments - accounts - customer_contacts - help_center - users - organization - teams type: string - name: search_mode required: false in: query description: >- Search mode - 'primary' for main search, 'fallback' for secondary search schema: $ref: '#/components/schemas/SearchMode' - name: q required: false in: query description: The search query schema: default: '*' example: '*' type: string - name: query_by required: true in: query description: Fields to query by (comma separated) schema: example: title,description type: string - name: streaming required: false in: query description: Enable streaming of paginated results schema: example: false type: boolean - name: filter_by required: false in: query description: Filter by expression schema: example: priorityName:=medium&&statusName:=resolved type: string - name: sort_by required: false in: query description: Sort by expression schema: type: string - name: facet_by required: false in: query description: Facet by fields (comma separated) schema: type: string - name: page required: false in: query description: Page number schema: type: string - name: per_page required: false in: query description: Results per page schema: example: '10' type: string - name: cursor required: false in: query description: Cursor for pagination schema: example: 01HQXYZ123456789 type: string - name: direction required: false in: query description: Navigation direction for cursor pagination schema: example: forward enum: - forward - backward - first - last type: string - name: group_by required: false in: query description: Group by fields (comma separated) schema: type: string - name: group_limit required: false in: query description: Group limit schema: type: string - name: include_fields required: false in: query description: Fields to include in the response (comma separated) schema: example: >- uid,title,statusName,createdAt,updatedAt,priorityName,ticketIdentifier type: string - name: exclude_fields required: false in: query description: Exclude fields (comma separated) schema: type: string responses: '200': description: Search result content: application/json: schema: type: object properties: result: type: object properties: facet_counts: type: array items: type: object found: type: number hits: type: array items: type: object properties: document: oneOf: - $ref: '#/components/schemas/TicketSearchResponseDto' - $ref: >- #/components/schemas/AccountSearchResponseDto - $ref: >- #/components/schemas/CommentSearchResponseDto - $ref: >- #/components/schemas/HelpCenterSearchResponseDto - $ref: '#/components/schemas/UserSearchResponseDto' - e86d53c2-56e1-4733-9cc4-ff51b0f1f210 - 9e083105-3ccf-443a-8983-3d53fbf50894 page: type: number request_params: type: object search_cutoff: type: boolean components: schemas: SearchMode: type: string enum: - primary - fallback TicketSearchResponseDto: type: object properties: id: type: string description: The unique identifier of the ticket ticketIdentifier: type: string description: The unique identifier of the ticket title: type: string description: The title of the ticket ticketId: type: number description: The ticket ID of the ticket description: type: string description: The description of the ticket source: type: string description: The source of the ticket accountId: type: string description: The account ID of the ticket status: type: string description: The status of the ticket statusId: type: string description: The status ID of the ticket priority: type: string description: The priority of the ticket priorityId: type: string description: The priority ID of the ticket storyPoints: type: number description: The story points of the ticket account: type: string description: The account of the ticket teamId: type: string description: The team ID of the ticket teamName: type: string description: The name of the team of the ticket teamIdentifier: type: string description: The identifier of the team of the ticket subTeamId: type: string description: The sub team ID of the ticket subTeamName: type: string description: The name of the sub team of the ticket subTeamIdentifier: type: string description: The identifier of the sub team of the ticket isPrivate: type: boolean description: Whether the ticket is private typeId: type: string description: The type ID of the ticket type: type: string description: The name of the type of the ticket assignedAgent: type: string description: The assigned agent of the ticket assignedAgentId: type: string description: The assigned agent ID of the ticket assignedAgentEmail: type: string description: The assigned agent email of the ticket assignedAgentAvatar: type: string description: The assigned agent avatar of the ticket requestorEmail: type: string description: The requestor email of the ticket customerContactId: type: string description: The customer contact ID of the ticket customerContactFirstName: type: string description: The customer contact first name of the ticket customerContactLastName: type: string description: The customer contact last name of the ticket customerContactEmail: type: string description: The customer contact email of the ticket submitterEmail: type: string description: The submitter email of the ticket customFieldValues: description: The custom field values type: array items: type: string deletedAt: type: string description: The deleted at date of the ticket archivedAt: type: string description: The archived at date of the ticket createdAt: type: string description: The created at date of the ticket updatedAt: type: string description: The updated at date of the ticket formId: type: string description: The form ID of the ticket aiGeneratedTitle: type: string description: The AI generated title of the ticket aiGeneratedSummary: type: string description: The AI generated summary of the ticket sentiment: type: string description: The sentiment of the ticket sentimentId: type: string description: The sentiment ID of the ticket teamIcon: type: string description: The team icon of the ticket teamColor: type: string description: The team color of the ticket teamOrganizationId: type: string description: The team organization ID of the ticket teamParentTeamId: type: string description: The team parent team ID of the ticket teamDescription: type: string description: The team description of the ticket teamConfigurationId: type: string description: The team configuration ID of the ticket teamTeamOwnerId: type: string description: The team team owner ID of the ticket teamIsActive: type: boolean description: The team is active of the ticket teamIsPrivate: type: boolean description: The team is private of the ticket teamCreatedAt: type: string description: The team created at of the ticket teamUpdatedAt: type: string description: The team updated at of the ticket teamDeletedAt: type: string description: The team deleted at of the ticket teamArchivedAt: type: string description: The team archived at of the ticket subTeamIcon: type: string description: The sub team icon of the ticket subTeamColor: type: string description: The sub team color of the ticket subTeamOrganizationId: type: string description: The sub team organization ID of the ticket subTeamParentTeamId: type: string description: The sub team parent team ID of the ticket subTeamDescription: type: string description: The sub team description of the ticket subTeamConfigurationId: type: string description: The sub team configuration ID of the ticket subTeamTeamOwnerId: type: string description: The sub team team owner ID of the ticket subTeamIsActive: type: boolean description: The sub team is active of the ticket subTeamIsPrivate: type: boolean description: The sub team is private of the ticket subTeamCreatedAt: type: string description: The sub team created at of the ticket subTeamUpdatedAt: type: string description: The sub team updated at of the ticket subTeamDeletedAt: type: string description: The sub team deleted at of the ticket subTeamArchivedAt: type: string description: The sub team archived at of the ticket lastCustomerComment: type: string description: The last customer comment timestamp lastVendorComment: type: string description: The last vendor comment timestamp closedAt: type: string description: The closed at date of the ticket nullable: true closedBy: type: string description: The display name of the user who closed the ticket nullable: true closedById: type: string description: The ID of the user who closed the ticket nullable: true closedByEmail: type: string description: The email of the user who closed the ticket nullable: true lastComment: type: string description: >- The last comment timestamp (max of lastCustomerComment and lastVendorComment) isEscalated: type: boolean description: Whether the ticket is escalated uid: type: string metadata: type: string organizationId: type: string organizationUid: type: string formUid: type: string formName: type: string formCreatedAt: type: string formUpdatedAt: type: string formOrder: type: string formDeletedAt: type: string formCreatedBy: type: string formTeamId: type: string formType: type: string formDefault: type: string accountPrimaryDomain: type: string accountWebsite: type: string accountAnnualRevenue: type: string accountEmployees: type: string accountOwnerId: type: string accountOwnerEmail: type: string accountOwnerName: type: string accountOwnerUserType: type: string accountOwnerStatus: type: string accountOwnerTimezone: type: string accountOwnerAvatarUrl: type: string teamUid: type: string subTeamUid: type: string assignedAgentName: type: string statusName: type: string statusUid: type: string priorityUid: type: string priorityName: type: string typeName: type: string typeUid: type: string typeIcon: type: string typeColor: type: string isDraft: type: boolean sentimentUid: type: string sentimentName: type: string dueDate: type: string contactEmail: type: string contactName: type: string contactPhone: type: string contactAvatarUrl: type: string ticketRelationshipsAsSource: type: array items: type: string ticketRelationshipsAsTarget: type: array items: type: string slaTotalResolutionTimeStatus: type: string slaTotalResolutionTimeScheduledAt: type: string slaTotalResolutionTimeBreachedAt: type: string slaTotalResolutionTimeAchievedAt: type: string slaTotalResolutionTimePausedAt: type: string slaTotalResolutionTimeResumedAt: type: string slaTotalResolutionTimeCancelledAt: type: string slaTotalResolutionTimeCreatedAt: type: string slaTotalResolutionTimeDurationToBreachMinutes: type: string slaTotalResolutionTimePausedDurationMinutes: type: string slaTotalResolutionTimeNextAttemptAt: type: string slaFirstTimeResponseStatus: type: string slaFirstTimeResponseScheduledAt: type: string slaFirstTimeResponseBreachedAt: type: string slaFirstTimeResponseAchievedAt: type: string slaFirstTimeResponsePausedAt: type: string slaFirstTimeResponseResumedAt: type: string slaFirstTimeResponseCancelledAt: type: string slaFirstTimeResponseDurationToBreachMinutes: type: string slaFirstTimeResponsePausedDurationMinutes: type: string slaFirstTimeResponseNextAttemptAt: type: string slaNextTimeResponseStatus: type: string slaNextTimeResponseScheduledAt: type: string slaNextTimeResponseBreachedAt: type: string slaNextTimeResponseAchievedAt: type: string slaNextTimeResponsePausedAt: type: string slaNextTimeResponseResumedAt: type: string slaNextTimeResponseCancelledAt: type: string slaNextTimeResponseDurationToBreachMinutes: type: string slaNextTimeResponsePausedDurationMinutes: type: string slaNextTimeResponseNextAttemptAt: type: string slaUpdateTimeStatus: type: string slaUpdateTimeScheduledAt: type: string slaUpdateTimeBreachedAt: type: string slaUpdateTimeAchievedAt: type: string slaUpdateTimePausedAt: type: string slaUpdateTimeResumedAt: type: string slaUpdateTimeCancelledAt: type: string slaUpdateTimeDurationToBreachMinutes: type: string slaUpdateTimePausedDurationMinutes: type: string slaUpdateTimeNextAttemptAt: type: string accountHealth: type: string accountSource: type: string isProactive: type: boolean proactiveChannels: type: array items: type: string accountIsActive: type: boolean accountIndustry: type: string accountClassification: type: string accountStatus: type: string accountUid: type: string accountLogo: type: string accountOwnerUid: type: string customFieldDeletedAt: type: string tags: type: object properties: values: type: array items: type: object properties: color: type: string created_at: type: string deleted_at: type: string description: type: string id: type: string is_active: type: string name: type: string organization_id: type: string tagType: type: string team_id: type: string uid: type: string updated_at: type: string assignedAgentUid: type: string assignedAgentAvatarUrl: type: string customerContactUid: type: string customerContactName: type: string accountHealthUid: type: string accountIndustryUid: type: string accountClassificationUid: type: string accountStatusUid: type: string accountHealthValue: type: string accountIndustryValue: type: string accountClassificationValue: type: string accountStatusValue: type: string slaTotalResolutionTimeComplianceState: type: string slaFirstTimeResponseComplianceState: type: string slaNextTimeResponseComplianceState: type: string slaUpdateComplianceState: type: string accountCustomFields: type: array items: type: string ticketCustomFieldValues: type: array items: type: string accountSecondaryDomain: type: string accountBillingAddress: type: string accountShippingAddress: type: string csatRatingValue: type: string csatCommentText: type: string csatCompletedAt: type: string csatMappingStatus: type: string csatSamplingStatus: type: string csatFeedbackType: type: string csatSurveyConfigRatingScale: type: number csatDeliveryDetailsRecipient: type: string csatDeliveryDetailsLastAttemptAt: type: string csatDeliveryDetailsDeliveryAttempts: type: number parentStatusUid: type: string parentStatusName: type: string slaFirstTimeResponseCreatedAt: type: string slaNextTimeResponseCreatedAt: type: string slaUpdateTimeCreatedAt: type: string required: - id - ticketIdentifier - title - ticketId - description - source - accountId - status - priority - storyPoints - account - teamId - teamName - subTeamName - subTeamIdentifier - isPrivate - type - assignedAgent - assignedAgentAvatar - requestorEmail - customerContactFirstName - customerContactLastName - submitterEmail - customFieldValues - createdAt - updatedAt - sentiment - teamIcon - teamColor - teamOrganizationId - teamParentTeamId - teamDescription - teamConfigurationId - teamTeamOwnerId - teamIsActive - teamIsPrivate - teamCreatedAt - teamUpdatedAt - teamDeletedAt - teamArchivedAt - subTeamIcon - subTeamColor - subTeamOrganizationId - subTeamParentTeamId - subTeamDescription - subTeamConfigurationId - subTeamTeamOwnerId - subTeamIsActive - subTeamIsPrivate - subTeamCreatedAt - subTeamUpdatedAt - subTeamDeletedAt - subTeamArchivedAt - lastCustomerComment - lastVendorComment - lastComment - uid - organizationId - organizationUid - teamUid AccountSearchResponseDto: type: object properties: data: description: Array of accounts matching the search criteria type: array items: $ref: '#/components/schemas/AccountSearchResponseItemDto' hasMore: type: boolean description: Whether there are more results available example: true nextCursor: type: string description: Cursor for the next page (UID of the last item) example: 01HQXYZ123456789 totalHits: type: number description: Total number of accounts matching the search query example: 150 required: - data - hasMore - totalHits CommentSearchResponseDto: type: object properties: ticket_id: type: string content: type: string description: The content of the comment created_at: type: string updated_at: type: string created_by_id: type: string created_by_email: type: string created_by_name: type: string team_uid: type: string team_identifier: type: string ticket_ticket_id: type: string comment_type: type: string comment_visibility: type: string is_edited: type: boolean is_pinned: type: boolean content_markdown: type: string content_html: type: string organization_id: type: string ticket_identifier: type: string ticket_uid: type: string organization_uid: type: string author_id: type: string author_name: type: string author_uid: type: string author_avatar_url: type: string author_user_type: type: string impersonated_user_email: type: string impersonated_user_name: type: string impersonated_user_avatar: type: string metadata: type: object description: The metadata of the comment parent_comment_id: type: string comment_thread_name: type: string source_email_id: type: string customer_contact_id: type: string customer_contact_email: type: string customer_contact_avatar_url: type: string customer_contact_first_name: type: string deleted_at: type: string id: type: string description: The ID of the comment contentHtml: type: string description: The HTML content of the comment contentMarkdown: type: string description: The markdown content of the comment threadName: type: string description: The thread name of the comment isEdited: type: boolean description: Indicates if the comment has been edited commentVisibility: type: string description: The visibility setting of the comment enum: - public - private commentType: type: string description: The type of the comment enum: - comment - reply - note isPinned: type: boolean description: Indicates if the comment is pinned sourceEmailId: type: string description: The source email ID nullable: true parentCommentId: type: string description: The parent comment ID nullable: true ticketUid: type: string description: The unique identifier of the ticket authorAvatarUrl: type: string description: The avatar URL of the author impersonatedUserEmail: type: string description: The impersonated user email impersonatedUserName: type: string description: The impersonated user name impersonatedUserAvatar: type: string description: The impersonated user avatar createdAt: type: string description: The creation date of the comment updatedAt: type: string description: The last update date of the comment author: type: string description: The name of the author attachments: description: The attachments of the comment type: array items: $ref: '#/components/schemas/CommentAttachmentDto' authorId: type: string description: The ID of the author authorUserType: type: string description: The user type of the author enum: - ORG_ADMIN - USER customerContactId: type: string description: The customer contact ID customerContactEmail: type: string description: The customer contact email customerContactAvatarUrl: type: string description: The customer contact avatar URL nullable: true customerContactFirstName: type: string description: The customer contact first name deletedAt: type: string description: The deletion date of the comment (null if not deleted) nullable: true required: - ticket_id - content - created_at - updated_at - created_by_id - team_uid - team_identifier - ticket_ticket_id - comment_type - comment_visibility - is_edited - is_pinned - content_markdown - content_html - organization_id - id - contentHtml - contentMarkdown - isEdited - commentVisibility - commentType - isPinned - sourceEmailId - parentCommentId - ticketUid - authorAvatarUrl - createdAt - updatedAt - author - attachments - authorId - authorUserType - customerContactId - customerContactEmail - customerContactAvatarUrl - customerContactFirstName - deletedAt HelpCenterSearchResponseDto: type: object properties: uid: type: string organizationUid: type: string title: type: string description: type: string body: type: string visibility: type: string tags: type: array items: type: string helpCenterIds: type: array items: type: string required: - uid - organizationUid - title - visibility - tags - helpCenterIds UserSearchResponseDto: type: object properties: id: type: string name: type: string email: type: string userType: type: string status: type: string isActive: type: boolean avatarUrl: type: string timezone: type: string default: UTC dailyConfig: type: object additionalProperties: type: object properties: isActive: type: boolean slots: type: array items: type: object properties: start: type: string end: type: string lastLoginAt: type: string createdAt: type: string updatedAt: type: string required: - id - name - email - userType - status - isActive - timezone AccountSearchResponseItemDto: type: object properties: uid: type: string description: The unique identifier of the account (ULID) example: 01HQXYZ123456789 name: type: string description: The name of the account example: Acme Corporation description: type: string description: The description of the account example: Leading provider of innovative solutions logo: type: string description: The logo URL of the account example: https://example.com/logo.png primaryDomain: type: string description: The primary domain of the account example: acme.com secondaryDomain: description: The secondary domains of the account example: - acme.co - acme.net type: array items: type: string source: type: string description: The source of the account example: hubspot website: type: string description: The website URL of the account example: https://acme.com annualRevenue: type: number description: The annual revenue of the account example: 1000000 employees: type: number description: The number of employees example: 100 billingAddress: type: string description: The billing address of the account example: 123 Main St, Anytown, USA shippingAddress: type: string description: The shipping address of the account example: 456 Oak Ave, Somewhere, USA statusValue: type: string description: The status value of the account example: Active statusUid: type: string description: The status UID of the account example: 01HQXYZ123456789 classificationValue: type: string description: The classification value of the account example: Enterprise classificationUid: type: string description: The classification UID of the account example: 01HQXYZ123456789 healthValue: type: string description: The health value of the account example: Good healthUid: type: string description: The health UID of the account example: 01HQXYZ123456789 industryValue: type: string description: The industry value of the account example: Technology industryUid: type: string description: The industry UID of the account example: 01HQXYZ123456789 accountOwnerName: type: string description: The account owner name example: John Smith accountOwnerUid: type: string description: The account owner UID example: 01HQXYZ123456789 accountOwnerEmail: type: string description: The account owner email example: john.smith@company.com createdAt: type: string description: The creation date of the account example: '2024-01-15T10:30:00.000Z' updatedAt: type: string description: The last update date of the account example: '2024-01-15T10:30:00.000Z' required: - uid - name - primaryDomain - createdAt - updatedAt CommentAttachmentDto: type: object properties: id: type: string description: The ID of the attachment url: type: string description: The URL of the attachment name: type: string description: The name of the attachment size: description: The size of the attachment type: array items: type: string contentType: type: string description: The content type of the attachment createdAt: type: string description: The creation date of the attachment required: - id - url - name - size - contentType - createdAt securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: 'Enter your API key ' ````