> ## Documentation Index > Fetch the complete documentation index at: https://docs.yampi.ai/llms.txt > Use this file to discover all available pages before exploring further. # Conversations Filter > Filter conversations with custom filter options and pagination ## OpenAPI ````yaml /openapi/application.json post /api/v1/accounts/{account_id}/conversations/filter openapi: 3.1.0 info: title: API de Yampi description: >- API de cuenta de Yampi: chats, inventario, negocios, contratos, tesorería y Livia. Autenticación con el header `api_access_token`. version: 1.2.0 termsOfService: https://yampi.ai/terms/ contact: email: hola@yampi.ai license: name: MIT License url: https://opensource.org/licenses/MIT servers: - url: https://app.yampi.ai description: Producción security: [] tags: - name: Agents description: Agent management APIs - name: Canned Responses description: Pre-defined responses for common queries - name: Contacts description: Contact management APIs - name: Contact Labels description: Manage contact labels - name: Conversation Assignments description: Manage conversation assignments - name: Conversation Labels description: Manage conversation labels - name: Conversations description: Conversation management APIs - name: Custom Attributes description: Custom fields for contacts and conversations - name: Custom Filters description: Saved filters for conversations - name: Inboxes description: Communication channels setup - name: Integrations description: Third-party integrations - name: Messages description: Message management APIs - name: Profile description: User profile APIs - name: Reports description: Analytics and reporting APIs - name: Teams description: Team management APIs - name: Webhooks description: Event notification webhooks - name: Automation Rule description: Workflow automation rules - name: Help Center description: Knowledge base management - name: Account description: Current account profile and settings - name: Audit Logs description: Account audit log - name: Properties description: Property portfolio APIs - name: Companies description: Company CRM APIs - name: Opportunities description: Opportunity CRM APIs - name: Opportunity Reminders description: Reminders on opportunities - name: Contract Templates description: Contract template library - name: Contract Submissions description: Contract sending and tracking - name: Livia description: Livia assistants - name: Livia Tareas description: Livia one-shot AI tasks - name: SLA Policies description: SLA policy management - name: Applied SLAs description: SLA instances applied to conversations - name: SAML Settings description: Account SAML SSO settings - name: Treasury Subscriptions description: Recurring treasury subscriptions - name: Treasury Payments description: Treasury payment recording - name: Treasury Payouts description: Subscription payouts - name: Treasury Adjustments description: Debit and credit adjustments - name: Treasury Rules description: Notification, retry, collection and tax rules - name: Treasury Dashboard description: Treasury dashboard - name: Treasury Settings description: Treasury account settings - name: Treasury Owners description: Owner statements - name: Treasury Reports description: Aging and commission reports - name: Livia Documentos description: Livia knowledge documents - name: Livia Escenarios description: Livia assistant scenarios - name: Livia Herramientas description: Livia custom HTTP tools - name: Livia Desk description: Livia copilot threads and messages - name: Livia Preferencias description: Account-level Livia preferences - name: Documents description: Account document library - name: Document Folders description: Document library folders - name: Calendar Events description: Account calendar, availability and booking links - name: Agent Tasks description: Agent task inbox and lifecycle - name: Labels description: Account labels - name: Notifications description: User notifications and notification settings - name: Search description: Account search and AI search - name: Macros description: Conversation macros - name: Campaigns description: Outbound campaigns - name: Flow Definitions description: Livia flow builder - name: Custom Roles description: Custom agent roles - name: Assignment Policies description: Conversation assignment policies - name: Requirements description: Capture requirements - name: Zones description: Location zones and cities - name: Geocoding description: Authenticated geocoding - name: Domains description: Account custom domains - name: Connector Clients description: MCP connector client identifiers - name: Presigned Contracts description: Already-signed contracts uploaded to the account - name: Contract Webhooks description: Outbound contract webhook URLs - name: Contracts Settings description: Account contracts settings - name: Treasury Disbursements description: Owner and agency disbursements - name: Treasury Collections description: Collection steps, notices, agreements and exceptions - name: Treasury Guarantees description: Rental guarantees and claims - name: Treasury E-Invoices description: Electronic invoicing - name: Treasury Available Contracts description: Completed contracts that can seed subscriptions - name: Opportunity Pipelines description: CRM funnels - name: Opportunity Columns description: CRM kanban columns - name: Opportunity Lose Reasons description: CRM lose reasons - name: Requirement Quotes description: Priced quotes on capture requirements - name: Conversation Participants description: Agents participating in a conversation - name: Conversation Draft Messages description: Per-conversation composer drafts - name: MCP description: Account-scoped MCP JSON-RPC server - name: Treasury Bank Batches description: Bank payout files and beneficiary account confirmation - name: Contact Assignment Requests description: Requests to be assigned a contact - name: Onboarding description: Account onboarding details - name: Owner Portal Invites description: Owner portal invite, eligibility and revoke - name: Channel Authorizations description: Start OAuth or embedded signup for inbox channels - name: CSAT Survey Responses description: Account CSAT responses, metrics and review notes - name: Dashboard description: Account dashboard summary and trends - name: Dashboard Apps description: Embedded dashboard apps - name: Bulk Actions description: Bulk conversation and contact actions - name: Assignable Agents description: Agents assignable across a set of inboxes - name: Tracking Pixels description: Advertising tracking pixels - name: Calls description: Account call history - name: WhatsApp Calls description: WhatsApp voice calls paths: /api/v1/accounts/{account_id}/conversations/filter: parameters: - $ref: '#/components/parameters/account_id' post: tags: - Conversations summary: Conversations Filter description: Filter conversations with custom filter options and pagination operationId: conversationFilter parameters: - name: page in: query schema: type: number requestBody: required: true content: application/json: schema: type: object properties: payload: type: array items: type: object properties: attribute_key: type: string description: filter attribute name filter_operator: type: string description: filter operator name enum: - equal_to - not_equal_to - contains - does_not_contain values: type: array items: type: string description: array of the attribute values to filter query_operator: type: string description: query operator name enum: - AND - OR example: - attribute_key: browser_language filter_operator: not_equal_to values: - en query_operator: AND - attribute_key: status filter_operator: equal_to values: - pending query_operator: null responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/conversation_list' '400': description: Bad Request Error content: application/json: schema: $ref: '#/components/schemas/bad_request_error' security: - userApiKey: [] components: parameters: account_id: in: path name: account_id schema: type: integer required: true description: The numeric ID of the account schemas: conversation_list: type: object properties: data: type: object properties: meta: type: object properties: mine_count: type: number unassigned_count: type: number assigned_count: type: number all_count: type: number payload: type: array description: array of conversations items: allOf: - $ref: '#/components/schemas/generic_id' - $ref: '#/components/schemas/conversation' - type: object properties: meta: type: object properties: sender: type: object properties: additional_attributes: type: object description: The additional attributes of the sender availability_status: type: string description: The availability status of the sender email: type: string description: The email of the sender id: type: number description: ID fo the sender name: type: string description: The name of the sender phone_number: type: string description: The phone number of the sender blocked: type: boolean description: Whether the sender is blocked identifier: type: string description: The identifier of the sender thumbnail: type: string description: Avatar URL of the contact custom_attributes: type: object description: The custom attributes of the sender last_activity_at: type: number description: The last activity at of the sender created_at: type: number description: The created at of the sender channel: type: string description: Channel Type assignee: $ref: '#/components/schemas/user' hmac_verified: type: boolean description: Whether the hmac is verified bad_request_error: title: data type: object properties: description: type: string errors: type: array items: $ref: '#/components/schemas/request_error' generic_id: type: object properties: id: type: number conversation: type: object properties: id: type: number description: ID of the conversation messages: type: array items: $ref: '#/components/schemas/message' account_id: type: number description: Account Id uuid: type: string description: UUID of the conversation additional_attributes: type: object description: >- The object containing additional attributes related to the conversation agent_last_seen_at: type: number description: The last activity at of the agent assignee_last_seen_at: type: number description: The last activity at of the assignee can_reply: type: boolean description: Whether the conversation can be replied to contact_last_seen_at: type: number description: The last activity at of the contact custom_attributes: type: object description: >- The object to save custom attributes for conversation, accepts custom attributes key and value inbox_id: type: number description: ID of the inbox labels: type: array items: type: string description: The labels of the conversation muted: type: boolean description: Whether the conversation is muted snoozed_until: type: number description: The time at which the conversation will be unmuted status: type: string enum: - open - resolved - pending description: The status of the conversation created_at: type: number description: The time at which conversation was created updated_at: type: number description: The time at which conversation was updated timestamp: type: string description: The time at which conversation was created first_reply_created_at: type: number description: The time at which the first reply was created unread_count: type: number description: The number of unread messages last_non_activity_message: $ref: '#/components/schemas/message' last_activity_at: type: number description: The last activity at of the conversation priority: type: string description: The priority of the conversation waiting_since: type: number description: The time at which the conversation was waiting sla_policy_id: type: number description: The ID of the SLA policy applied_sla: type: object description: The applied SLA sla_events: type: array items: type: object description: SLA event objects user: type: object properties: id: type: number access_token: type: string account_id: type: number available_name: type: string avatar_url: type: string confirmed: type: boolean display_name: type: string nullable: true message_signature: type: string nullable: true email: type: string hmac_identifier: type: string inviter_id: type: number name: type: string provider: type: string pubsub_token: type: string role: type: string enum: - agent - administrator ui_settings: type: object uid: type: string type: type: string nullable: true custom_attributes: type: object description: Custom attributes associated with the user. accounts: type: array items: type: object properties: id: type: number name: type: string status: type: string active_at: type: string format: date-time role: type: string enum: - administrator - agent permissions: type: array items: type: string availability: type: string availability_status: type: string auto_offline: type: boolean custom_role_id: type: number nullable: true custom_role: type: object nullable: true request_error: type: object properties: field: type: string message: type: string code: type: string message: type: object properties: id: type: number description: The ID of the message content: type: string description: The text content of the message account_id: type: number description: The ID of the account inbox_id: type: number description: The ID of the inbox conversation_id: type: number description: The ID of the conversation message_type: type: integer enum: - 0 - 1 - 2 description: The type of the message created_at: type: integer description: The time at which message was created updated_at: type: integer description: The time at which message was updated private: type: boolean description: The flags which shows whether the message is private or not status: type: string enum: - sent - delivered - read - failed description: The status of the message source_id: type: string description: The source ID of the message content_type: type: string enum: - text - input_select - cards - form description: The type of the template message content_attributes: type: object description: The content attributes for each content_type sender_type: type: string enum: - contact - agent - agent_bot description: The type of the sender sender_id: type: number description: The ID of the sender external_source_ids: type: object description: The external source IDs of the message additional_attributes: type: object description: The additional attributes of the message processed_message_content: type: string description: The processed message content sentiment: type: object description: The sentiment of the message conversation: type: object description: The conversation object attachment: type: object description: The file object attached to the image sender: type: object description: User/Agent/AgentBot object securitySchemes: userApiKey: type: apiKey in: header name: api_access_token description: >- Token de usuario. Envía el valor en el header `api_access_token`. Lo obtienes en el perfil (`GET /api/v1/profile`) o al regenerarlo. ````