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



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json get /time-sheet/
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:
  /time-sheet/:
    get:
      tags:
        - TimeSheets
      summary: Listar apontamentos
      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: title
          required: false
          description: Filtra por título
        - schema:
            type: string
            enum:
              - TASK
              - AUDIENCE
              - SUBTASK
              - GENERAL
          in: query
          name: module
          required: false
          description: Filtra por módulo
        - schema:
            type: string
            enum:
              - PENDING
              - IN_PROGRESS
              - PAUSED
              - COMPLETED
              - CANCELLED
              - FINISHED
          in: query
          name: status
          required: false
          description: Filtra pelo status atual (FINISHED = Concluídos + Cancelados)
        - schema:
            type: string
          in: query
          name: isDone
          required: false
          description: true ou false
        - schema:
            type: string
            format: uuid
          in: query
          name: userId
          required: false
          description: Filtra por usuário
        - schema:
            type: string
            format: uuid
          in: query
          name: taskId
          required: false
          description: Filtra por tarefa
        - schema:
            type: string
            format: uuid
          in: query
          name: audienceId
          required: false
          description: Filtra por audiência
        - schema:
            type: string
            format: uuid
          in: query
          name: subtaskId
          required: false
          description: Filtra por subtarefa
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: orderBy
          required: false
          description: asc ou desc
        - schema:
            type: string
          in: query
          name: orderByField
          required: false
          description: Campo de ordenação
      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 apontamento
                        title:
                          type: string
                          description: Título
                        module:
                          type: string
                          enum:
                            - TASK
                            - AUDIENCE
                            - SUBTASK
                            - GENERAL
                          description: Módulo
                        isDone:
                          type: boolean
                          description: Concluído
                        status:
                          type: string
                          enum:
                            - PENDING
                            - IN_PROGRESS
                            - PAUSED
                            - COMPLETED
                            - CANCELLED
                          nullable: true
                          description: Status atual
                        officeId:
                          type: string
                          description: ID do escritório
                        userId:
                          type: string
                          nullable: true
                          description: ID do usuário
                        taskId:
                          type: string
                          nullable: true
                          description: ID da tarefa
                        audienceId:
                          type: string
                          nullable: true
                          description: ID da audiência
                        subtaskId:
                          type: string
                          nullable: true
                          description: ID da subtarefa
                        estimatedTimeMinutes:
                          type: number
                          nullable: true
                          description: Tempo estimado (minutos)
                        timeSpentSeconds:
                          type: number
                          description: Tempo gasto somando os históricos (segundos)
                        cancelReason:
                          type: string
                          nullable: true
                          description: Motivo do cancelamento
                        completedAt:
                          type: string
                          format: date-time
                          nullable: true
                          description: Data de finalização (conclusão/cancelamento)
                        vinculateItem:
                          type: object
                          properties:
                            id:
                              type: string
                              description: ID do item vinculado
                            name:
                              type: string
                              description: Nome/título do item vinculado
                            processNumber:
                              type: string
                              nullable: true
                              description: Número do processo vinculado
                          required:
                            - id
                            - name
                          additionalProperties: false
                          nullable: true
                          description: Item vinculado (tarefa/subtarefa/audiência)
                        thisUserCanEdit:
                          type: boolean
                          description: >-
                            Indica se o usuário da requisição é o dono do
                            apontamento
                        userDetail:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Nome do usuário
                            urlImage:
                              type: string
                              nullable: true
                              description: URL da imagem do usuário
                          required:
                            - name
                          additionalProperties: false
                          nullable: true
                          description: Dados do usuário do apontamento
                        statusHistories:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: ID do histórico
                              description:
                                type: string
                                nullable: true
                                description: Descrição
                              status:
                                type: string
                                enum:
                                  - PENDING
                                  - IN_PROGRESS
                                  - PAUSED
                                  - COMPLETED
                                  - CANCELLED
                                description: Status
                              startedAt:
                                type: string
                                format: date-time
                                description: Início do status
                              endedAt:
                                type: string
                                format: date-time
                                nullable: true
                                description: Fim do status
                              timeSpent:
                                type: number
                                nullable: true
                                description: Tempo gasto (segundos)
                              createdAt:
                                type: string
                                format: date-time
                                description: Data de criação
                              updatedAt:
                                type: string
                                format: date-time
                                description: Data de atualização
                            required:
                              - id
                              - status
                              - startedAt
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                          description: Históricos de status
                        createdAt:
                          type: string
                          format: date-time
                          description: Data de criação
                        updatedAt:
                          type: string
                          format: date-time
                          description: Data de atualização
                      required:
                        - id
                        - title
                        - module
                        - isDone
                        - officeId
                        - timeSpentSeconds
                        - createdAt
                        - updatedAt
                      additionalProperties: true
                    description: Lista de apontamentos
                  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.

````