> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jurichat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar agentes

> Lista agentes com filtros e paginação



## OpenAPI

````yaml https://api.jurichat.com/docs/client/openapi.json get /agents/
openapi: 3.1.0
info:
  title: JuriChat API — Documentação para Integradores
  description: ''
  version: 1.0.0
servers:
  - url: https://api.jurichat.com
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /agents/:
    get:
      tags:
        - Agents
      summary: Listar agentes
      description: Lista agentes com filtros e paginação
      parameters:
        - schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
          in: query
          name: inboxId
          required: true
          description: ID da inbox.
        - schema:
            type: string
          in: query
          name: name
          required: false
          description: Filtra agentes pelo nome.
        - schema:
            type: string
          in: query
          name: communicationStyle
          required: false
          description: Filtra pelo estilo de comunicação.
        - schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
          in: query
          name: integrationId
          required: false
          description: Filtra agentes vinculados a uma integração.
        - schema:
            anyOf:
              - type: string
              - type: number
          in: query
          name: page
          required: false
          description: Número da página.
        - schema:
            anyOf:
              - type: string
              - type: number
          in: query
          name: limit
          required: false
          description: Quantidade de itens por página.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        avatarUrl:
                          type: string
                          nullable: true
                        communicationStyle:
                          type: string
                        behavior:
                          type: string
                        purpose:
                          type: string
                        agentModelId:
                          type: string
                        productName:
                          type: string
                          nullable: true
                        productSite:
                          type: string
                          nullable: true
                        productDescription:
                          type: string
                          nullable: true
                        inboxId:
                          type: string
                        hasConversationsActive:
                          type: boolean
                        hasIntegrationActive:
                          type: boolean
                        activePeriodEnabled:
                          type: boolean
                        activePeriodPreset:
                          type: string
                          nullable: true
                        allowConsultingProcesses:
                          type: boolean
                        canCreateTickets:
                          type: boolean
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                        idleActions:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              timeoutMinutes:
                                type: number
                                nullable: true
                              maxAttempts:
                                type: number
                              action:
                                type: string
                              customMessage:
                                type: string
                                nullable: true
                              enabled:
                                type: boolean
                              priority:
                                type: number
                                nullable: true
                              createdAt:
                                type: string
                                format: date-time
                              updatedAt:
                                type: string
                                format: date-time
                            required:
                              - id
                              - timeoutMinutes
                              - maxAttempts
                              - action
                              - customMessage
                              - enabled
                              - priority
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                        transferRules:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              condition:
                                type: string
                              keywords:
                                type: array
                                items:
                                  type: string
                              sentimentThreshold:
                                type: number
                                nullable: true
                              interactionCount:
                                type: number
                                nullable: true
                              responseTimeMinutes:
                                type: number
                                nullable: true
                              customCondition:
                                type: string
                                nullable: true
                              transferMessage:
                                type: string
                                nullable: true
                              enabled:
                                type: boolean
                              priority:
                                type: number
                              createdAt:
                                type: string
                                format: date-time
                              updatedAt:
                                type: string
                                format: date-time
                            required:
                              - id
                              - condition
                              - keywords
                              - sentimentThreshold
                              - interactionCount
                              - responseTimeMinutes
                              - customCondition
                              - transferMessage
                              - enabled
                              - priority
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                        ticketRules:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              condition:
                                type: string
                              keywords:
                                type: array
                                items:
                                  type: string
                              sentimentThreshold:
                                type: number
                                nullable: true
                              interactionCount:
                                type: number
                                nullable: true
                              responseTimeMinutes:
                                type: number
                                nullable: true
                              customCondition:
                                type: string
                                nullable: true
                              enabled:
                                type: boolean
                              priority:
                                type: number
                              ticketTitle:
                                type: string
                              ticketDescription:
                                type: string
                                nullable: true
                              ticketPriority:
                                type: string
                              statusId:
                                type: string
                                nullable: true
                              assigneeIds:
                                type: array
                                items:
                                  type: string
                              departmentIds:
                                type: array
                                items:
                                  type: string
                              createdAt:
                                type: string
                                format: date-time
                              updatedAt:
                                type: string
                                format: date-time
                            required:
                              - id
                              - condition
                              - keywords
                              - sentimentThreshold
                              - interactionCount
                              - responseTimeMinutes
                              - customCondition
                              - enabled
                              - priority
                              - ticketTitle
                              - ticketDescription
                              - ticketPriority
                              - statusId
                              - assigneeIds
                              - departmentIds
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                        tagRules:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              condition:
                                type: string
                              keywords:
                                type: array
                                items:
                                  type: string
                              sentimentThreshold:
                                type: number
                                nullable: true
                              interactionCount:
                                type: number
                                nullable: true
                              customCondition:
                                type: string
                                nullable: true
                              tagIds:
                                type: array
                                items:
                                  type: string
                              enabled:
                                type: boolean
                              priority:
                                type: number
                              createdAt:
                                type: string
                                format: date-time
                              updatedAt:
                                type: string
                                format: date-time
                            required:
                              - id
                              - condition
                              - keywords
                              - sentimentThreshold
                              - interactionCount
                              - customCondition
                              - tagIds
                              - enabled
                              - priority
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                        crmRules:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              condition:
                                type: string
                              keywords:
                                type: array
                                items:
                                  type: string
                              sentimentThreshold:
                                type: number
                                nullable: true
                              interactionCount:
                                type: number
                                nullable: true
                              customCondition:
                                type: string
                                nullable: true
                              funnelColumnId:
                                type: string
                              enabled:
                                type: boolean
                              priority:
                                type: number
                              createdAt:
                                type: string
                                format: date-time
                              updatedAt:
                                type: string
                                format: date-time
                            required:
                              - id
                              - condition
                              - keywords
                              - sentimentThreshold
                              - interactionCount
                              - customCondition
                              - funnelColumnId
                              - enabled
                              - priority
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                        customSchedule:
                          type: array
                          items:
                            type: object
                            properties:
                              dayOfWeek:
                                type: string
                              enabled:
                                type: boolean
                              startTime:
                                type: string
                              endTime:
                                type: string
                            required:
                              - dayOfWeek
                              - enabled
                              - startTime
                              - endTime
                            additionalProperties: false
                          nullable: true
                      required:
                        - id
                        - name
                        - avatarUrl
                        - communicationStyle
                        - behavior
                        - purpose
                        - agentModelId
                        - productName
                        - productSite
                        - productDescription
                        - inboxId
                        - hasConversationsActive
                        - hasIntegrationActive
                        - activePeriodEnabled
                        - activePeriodPreset
                        - allowConsultingProcesses
                        - createdAt
                        - updatedAt
                        - idleActions
                        - transferRules
                        - ticketRules
                        - tagRules
                        - crmRules
                        - customSchedule
                      additionalProperties: false
                  totalResults:
                    type: number
                  totalPages:
                    type: number
                required:
                  - data
                  - totalResults
                  - totalPages
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  code:
                    type: string
                  details:
                    anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - type: object
                        properties: {}
                        additionalProperties: true
                    description: Detalhes adicionais do erro.
                required:
                  - message
                  - statusCode
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-jurichat-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-jurichat-api-key.

````