Front API

Getting access, Developing, Testing

Back to Front

Search conversations

Search for conversations. Response will include a count of total matches and an array of conversations in descending order by last activity. See the search syntax documentation for usage examples.

⚠️ Deprecated field included

This endpoint returns a deprecated last_message field in the top-level conversation bodies listed. Please use the _links.related.last_message field instead.

Input

type: object properties: parameters: type: object properties: limit: type: number description: Max number of results per page page_token: type: string description: Token to use to request the next page query: type: string description: >- (Required) Search query string. See available Conversation Search Parameters below required: - query title: Parameters

Output

type: object properties: _pagination: type: object properties: next: type: string _total: type: number _results: type: array items: type: object properties: _links: type: object properties: self: type: string related: type: object properties: events: type: string followers: type: string messages: type: string comments: type: string inboxes: type: string last_message: type: string id: type: string subject: type: string status: type: string assignee: type: object properties: _links: type: object properties: self: type: string related: type: object properties: inboxes: type: string conversations: type: string id: type: string email: type: string username: type: string first_name: type: string last_name: type: string is_admin: type: boolean is_available: type: boolean is_blocked: type: boolean recipient: type: object properties: _links: type: object properties: related: type: object properties: contact: type: string handle: type: string role: type: string tags: type: array items: type: object properties: _links: type: object properties: self: type: string related: type: object properties: conversations: type: string owner: type: string children: type: string id: type: string name: type: string highlight: type: string is_private: type: boolean is_visible_in_conversation_lists: type: boolean created_at: type: number updated_at: type: number links: type: array items: type: object properties: _links: type: object properties: self: type: string id: type: string name: type: string type: type: string external_url: type: string created_at: type: number is_private: type: boolean scheduled_reminders: type: array items: type: object properties: _links: type: object properties: related: type: object properties: owner: type: string created_at: type: number scheduled_at: type: number updated_at: type: number metadata: type: object properties: external_conversation_ids: type: array items: type: string