> ## 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 contatos

> Lista contatos da inbox com filtros por nome, e-mail, bloqueio e tags. Use `page` e `limit` juntos para paginar; sem eles, retorna todos os registros.



## OpenAPI

````yaml https://api.jurichat.com/docs/client/openapi.json get /people/
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:
  /people/:
    get:
      tags:
        - Contacts
      summary: Listar contatos
      description: >-
        Lista contatos da inbox com filtros por nome, e-mail, bloqueio e tags.
        Use `page` e `limit` juntos para paginar; sem eles, retorna todos os
        registros.
      parameters:
        - 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.
        - schema:
            type: string
          in: query
          name: inboxId
          required: true
          description: ID da inbox. Obrigatório para filtrar os contatos.
        - schema:
            type: string
          in: query
          name: name
          required: false
          description: >-
            Filtra por nome (parcial) ou por trecho do telefone quando o texto
            contiver números.
        - schema:
            type: string
            format: email
          in: query
          name: email
          required: false
          description: Filtra por e-mail (correspondência parcial).
        - schema:
            type: boolean
          in: query
          name: isBlocked
          required: false
          description: 'Filtra por status de bloqueio: `true` ou `false`.'
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          in: query
          name: tags
          required: false
          description: Filtra contatos que possuam ao menos uma das tags informadas (IDs).
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: ID do contato.
                        name:
                          type: string
                          description: Nome do contato.
                        email:
                          type: string
                          nullable: true
                          description: E-mail ou null.
                        imageUrl:
                          type: string
                          nullable: true
                          description: URL de avatar ou null.
                        phoneNumber:
                          type: string
                          nullable: true
                          description: Número de telefone. Null se não informado.
                        document:
                          type: string
                          nullable: true
                          description: CPF, CNPJ ou outro documento. Null se não informado.
                        description:
                          type: string
                          nullable: true
                          description: Anotações sobre o contato. Null se não informado.
                        country:
                          type: string
                          nullable: true
                          description: País. Null se não informado.
                        city:
                          type: string
                          nullable: true
                          description: Cidade. Null se não informado.
                        isBlocked:
                          type: boolean
                          description: Indica se o contato está bloqueado.
                        inboxId:
                          type: string
                          description: ID da inbox à qual o contato pertence.
                        createdAt:
                          type: string
                          format: date-time
                          description: Data e hora de criação.
                        updatedAt:
                          type: string
                          format: date-time
                          description: Data e hora da última atualização.
                        conversationId:
                          type: string
                          nullable: true
                          description: >-
                            ID da conversa vinculada ao contato. Null se não
                            houver.
                        externalIdentitySource:
                          type: string
                          enum:
                            - WEB_CHAT
                            - INSTAGRAM
                          nullable: true
                          description: >-
                            Origem externa do contato quando não veio de
                            telefone.
                        externalIdentityId:
                          type: string
                          nullable: true
                          description: >-
                            Identificador externo do contato (ex.: sessão do web
                            chat).
                        tags:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: ID da tag.
                              name:
                                type: string
                                description: Nome exibido (UI).
                              color:
                                type: string
                                description: 'Cor no formato aceito pelo produto (ex.: hex).'
                            required:
                              - id
                              - name
                              - color
                            additionalProperties: false
                          description: Tags associadas ao contato.
                      required:
                        - id
                        - name
                        - email
                        - imageUrl
                        - phoneNumber
                        - document
                        - description
                        - country
                        - city
                        - isBlocked
                        - inboxId
                        - createdAt
                        - updatedAt
                        - conversationId
                        - tags
                      additionalProperties: false
                    description: Itens da página atual.
                  totalResults:
                    type: number
                    description: Total de registros encontrados.
                  totalPages:
                    type: number
                    description: Total de páginas para a quantidade solicitada.
                required:
                  - data
                  - totalResults
                  - totalPages
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  details: {}
                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.

````