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

# Listar usuários



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json get /user/
openapi: 3.1.0
info:
  title: Juridiq API — Documentação para Integradores
  description: ''
  version: 1.0.0
servers:
  - url: https://api.juridiq.com.br
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /user/:
    get:
      tags:
        - Users
      summary: Listar usuários
      parameters:
        - schema:
            type: string
          in: query
          name: page
          required: false
          description: Página. Começa em 1
        - schema:
            type: string
          in: query
          name: limit
          required: false
          description: Itens por página
        - schema:
            type: string
          in: query
          name: name
          required: false
          description: Filtra por nome
        - schema:
            type: string
          in: query
          name: profile
          required: false
          description: Filtra por nome do perfil
        - schema:
            type: string
          in: query
          name: orderBy
          required: false
          description: Ordenação por criação. asc ou desc
      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 usuário
                        name:
                          type: string
                          description: Nome completo
                        email:
                          type: string
                          description: E-mail de login
                        document:
                          type: string
                          nullable: true
                          description: CPF ou CNPJ
                        contact:
                          type: string
                          nullable: true
                          description: Telefone ou contato
                        role:
                          type: string
                          description: Cargo no escritório
                        admissionDate:
                          type: string
                          nullable: true
                          description: Data de admissão
                        resignationDate:
                          type: string
                          nullable: true
                          description: Data de demissão
                        dateOfBirth:
                          type: string
                          nullable: true
                          description: Data de nascimento
                        ctpsNumber:
                          type: string
                          nullable: true
                          description: Número da CTPS
                        imageUrl:
                          type: string
                          nullable: true
                          description: URL da foto
                        oabNumber:
                          type: string
                          nullable: true
                          description: Número da OAB
                        personType:
                          type: string
                          nullable: true
                          description: 'Tipo de pessoa. Ex: física, jurídica'
                        salary:
                          type: string
                          nullable: true
                          description: Salário
                        postalCode:
                          type: string
                          nullable: true
                          description: CEP
                        addressNumber:
                          type: string
                          nullable: true
                          description: Número do endereço
                        firstLogin:
                          type: boolean
                          nullable: true
                          description: Primeiro acesso pendente
                        showBannerAsaas:
                          type: boolean
                          nullable: true
                          description: Exibir banner Asaas
                        officeId:
                          type: string
                          description: ID do escritório
                        referralToken:
                          type: string
                          nullable: true
                          description: Token de indicação
                        googleIntegrationType:
                          type: string
                          enum:
                            - full-sync
                          nullable: true
                          description: Tipo de integração Google
                        profile:
                          type: object
                          properties:
                            id:
                              type: string
                              description: ID do perfil
                            name:
                              type: string
                              description: Nome do perfil
                          required:
                            - id
                            - name
                          additionalProperties: false
                        createdAt:
                          type: string
                          description: Data de criação (ISO 8601)
                        updatedAt:
                          type: string
                          description: Data da última alteração (ISO 8601)
                        hasGoogleLinked:
                          type: boolean
                          description: Possui conta Google vinculada
                        googleEmail:
                          type: string
                          nullable: true
                          description: E-mail da conta Google vinculada
                        hasPassword:
                          type: boolean
                          description: Possui senha cadastrada
                      required:
                        - id
                        - name
                        - email
                        - role
                        - officeId
                        - profile
                        - createdAt
                        - updatedAt
                        - hasGoogleLinked
                        - hasPassword
                      additionalProperties: false
                    description: Lista de usuários
                  totalResults:
                    type: number
                    description: Total de registros
                  totalPages:
                    type: number
                    description: Total de páginas
                required:
                  - data
                  - totalResults
                  - totalPages
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-juridiq-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-juridiq-api-key.

````