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

# Retorna usuários cadastradas no sistema

> Retorna lista de usuários cadastradas no sistema



## OpenAPI

````yaml /api-convertr/openapi.yaml get /pessoas
openapi: 3.1.0
info:
  title: Agulhão API - Convertr
  description: API do sistema Agulhão para integração com Convertr.
  contact:
    email: contato@softros.com.br
    url: https://agulhao.com.br
  version: 1.0.1
servers:
  - url: https://api-integracoes.agulhao.com.br
    description: Produção
security: []
tags:
  - name: filiais-cr
  - name: pessoas-cr
  - name: produtos-cr
  - name: pedidos-cr
  - name: tipos-lancamento-cr
externalDocs:
  description: Mais sobre a API
  url: https://docs.agulhao.com.br/api
paths:
  /pessoas:
    get:
      tags:
        - pessoas-cr
      summary: Retorna usuários cadastradas no sistema
      description: Retorna lista de usuários cadastradas no sistema
      operationId: getPessoas
      parameters:
        - name: pagina
          in: query
          description: Página atual da busca
          schema:
            type: string
            default: '1'
        - name: qtdePorPagina
          in: query
          description: Quantidade de usuários por página
          schema:
            type: string
            default: '100'
        - name: ultimaAtualizacao
          in: query
          description: Retorna apenas usuários que foram atualizados após a data informada
          schema:
            type: string
            format: date-time
            example: '2025-01-01T00:00:00'
        - name: vendedor
          in: query
          description: Retorna apenas usuários que são vendedores
          schema:
            type: string
            default: '0'
            enum:
              - '1'
              - '0'
        - name: cliente
          in: query
          description: Retorna apenas usuários que são clientes
          schema:
            type: string
            default: '0'
            enum:
              - '1'
              - '0'
        - name: guia
          in: query
          description: Retorna apenas usuários que são guias
          schema:
            type: string
            default: '0'
            enum:
              - '1'
              - '0'
      responses:
        '200':
          description: Sucesso
          headers:
            x-tem-proxima-pagina:
              description: Indica se há uma próxima página de resultados
              schema:
                type: string
                example:
                  - 'true'
                  - 'false'
            x-pagina:
              description: Página atual da busca
              schema:
                type: string
                example: '1'
            x-qtde-por-pagina:
              description: Quantidade de usuários por página
              schema:
                type: string
                example: '100'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Identificador único do usuário
                      example: '1'
                    razaoSocial:
                      type: string
                      description: Razão social do usuário
                      example: RAZÃO SOCIAL DA EMPRESA
                    documento:
                      type: string
                      description: CNPJ ou CPF do usuário
                      example: '00000000000000'
                    fantasia:
                      type: string
                      description: Nome fantasia do usuário
                      example: FANTASIA DA EMPRESA
                    email:
                      type: string
                      description: E-mail do usuário
                      example: contato@empresa.com
                    telefone:
                      type: string
                      description: Telefone do usuário
                      example: '1112345678'
                    celular:
                      type: string
                      description: Celular do usuário
                      example: '11912345678'
                    guia:
                      type: boolean
                      description: Indica se o usuário é um guia
                      example: true
                    vendedor:
                      type: boolean
                      description: Indica se o usuário é um vendedor
                      example: false
                    cliente:
                      type: boolean
                      description: Indica se o usuário é um cliente
                      example: true
                    ultimaAtualizacao:
                      type: string
                      format: date-time
                      description: Data da última atualização do usuário
                      example: '2025-01-01T00:00:00'
                    endereco:
                      type: object
                      properties:
                        cidadeId:
                          type: string
                          description: Identificador da cidade do endereço (Código IBGE)
                          example: '1'
                        cidadeNome:
                          type: string
                          description: Nome da cidade do endereço
                          example: São Paulo
                        uf:
                          type: string
                          description: Sigla da unidade federativa do endereço
                          example: SP
                        cep:
                          type: string
                          description: CEP do endereço
                          example: '01000000'
                        logradouro:
                          type: string
                          description: Logradouro do endereço
                          example: Avenida Paulista
                        numero:
                          type: string
                          description: Número do endereço
                          example: '1000'
                        complemento:
                          type: string
                          description: Complemento do endereço
                          example: Apto 101
                        bairro:
                          type: string
                          description: Bairro do endereço
                          example: Bela Vista
      security:
        - chaveApi: []
components:
  securitySchemes:
    chaveApi:
      description: Chave da API gerada no agulhão
      type: apiKey
      name: x-api-key
      in: header

````