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

# Listar metas

> Retorna a lista paginada de metas, ordenada por status (ativas primeiro) e por data de criação decrescente. Cada meta inclui suas metas filhas, a contagem de resultados e a variação percentual de progresso em relação ao último resultado registrado.



## OpenAPI

````yaml /api-reference/openapi.json get /api/management/goals
openapi: 3.0.0
info:
  title: Olie API
  version: 1.0.0
  description: >
    # Introdução 👋


    Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/).
    Aqui você encontra as referências e exemplos de uso dos nossos endpoints.


    Para uma visão completa, recomendamos fortemente que você leia a
    [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá
    estão detalhados tópicos essenciais como
    [autenticação](https://docs.olie.ai/api-reference/introduction/authentication),
    [estrutura de
    respostas](https://docs.olie.ai/api-reference/general/response-structure),
    [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros
    guias de integração.


    No Postman, esta coleção foca nas informações específicas de cada requisição
    (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e
    desenvolvimento.
servers:
  - url: https://api.olie.ai
security:
  - BearerAuth: []
paths:
  /api/management/goals:
    get:
      tags:
        - goals
      summary: Listar metas
      description: >-
        Retorna a lista paginada de metas, ordenada por status (ativas primeiro)
        e por data de criação decrescente. Cada meta inclui suas metas filhas, a
        contagem de resultados e a variação percentual de progresso em relação
        ao último resultado registrado.
      operationId: listarMetas
      parameters:
        - name: filter[title]
          in: query
          description: Filtra por título (correspondência parcial).
          schema:
            type: string
          example: ''
        - name: filter[status]
          in: query
          description: 'Filtra pelo status exato: active, inactive ou completed.'
          schema:
            type: string
            enum:
              - active
              - ' inactive'
              - ' completed'
          example: ''
        - name: filter[type]
          in: query
          description: >-
            Filtra pelo tipo exato: manual, projects_created,
            projects_created_by_user, funnel_steps_links,
            funnel_steps_links_by_user ou composite.
          schema:
            type: string
          example: ''
        - name: filter[comparison_mode]
          in: query
          description: >-
            Filtra pelo modo de comparação: target (atingir a meta) ou limit
            (não ultrapassar).
          schema:
            type: string
          example: ''
        - name: filter[periodicity]
          in: query
          description: Filtra pela periodicidade exata, em dias.
          schema:
            type: string
          example: ''
        - name: filter[user_id]
          in: query
          description: Filtra metas cujo user_id corresponde ao ID do usuário informado.
          schema:
            type: string
          example: ''
        - name: filter[funnel_step_id]
          in: query
          description: >-
            Filtra metas cujo funnel_step_id corresponde ao ID da etapa de funil
            informada.
          schema:
            type: string
          example: ''
        - name: filter[start_date_gte]
          in: query
          description: >-
            Retorna metas com data de início maior ou igual à data informada
            (YYYY-MM-DD).
          schema:
            type: string
          example: ''
        - name: filter[end_date_lte]
          in: query
          description: >-
            Retorna metas com data de término menor ou igual à data informada
            (YYYY-MM-DD).
          schema:
            type: string
          example: ''
        - name: filter[trashed]
          in: query
          description: >-
            Controla metas removidas (soft delete): with inclui removidas, only
            retorna apenas removidas, without (padrão) as ignora.
          schema:
            type: string
          example: ''
        - name: sort
          in: query
          description: >-
            Ordenação. Nome do campo para ascendente ou prefixado com '-' para
            descendente; múltiplos separados por vírgula. Campos: title, status,
            created_at, updated_at, start_date, end_date, target, progress,
            periodicity. Padrão: status,-created_at.
          schema:
            type: string
          example: ''
        - name: page
          in: query
          description: Número da página. Padrão 1.
          schema:
            type: string
          example: ''
        - name: perPage
          in: query
          description: Itens por página. Padrão 30, máximo 100.
          schema:
            type: string
          example: ''
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  goals:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        title:
                          type: string
                        description:
                          type: string
                        status:
                          type: string
                        start_date:
                          type: string
                          format: date
                        end_date:
                          type: string
                          format: date
                        periodicity:
                          type: integer
                        type:
                          type: string
                        user_id:
                          type: string
                          description: >-
                            ID do usuário associado à meta (tipos
                            projects_created_by_user e
                            funnel_steps_links_by_user).
                          format: uuid
                        funnel_step_id:
                          type: integer
                          description: >-
                            ID da etapa do funil (tipos funnel_steps_links e
                            funnel_steps_links_by_user).
                        target:
                          type: integer
                        unit:
                          type: string
                        comparison_mode:
                          type: string
                        progress:
                          type: integer
                        children:
                          type: array
                          items: {}
                        progress_change_percentage:
                          type: integer
                        percentage:
                          type: integer
                        results_count:
                          type: integer
                        is_past_calculable:
                          type: boolean
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      from:
                        type: integer
                      last_page:
                        type: integer
                      per_page:
                        type: integer
                      to:
                        type: integer
                      total:
                        type: integer
                  response:
                    type: boolean
              example:
                goals:
                  - id: 9b2d1f4a-3c5e-4a7b-8d9f-1e2c3a4b5c6d
                    title: Projetos criados no mês
                    description: Total de novos projetos abertos no período.
                    status: active
                    start_date: '2026-01-01'
                    end_date: '2026-12-31'
                    periodicity: 30
                    type: projects_created
                    user_id: null
                    funnel_step_id: null
                    target: 50
                    unit: count
                    comparison_mode: target
                    progress: 32
                    children: []
                    progress_change_percentage: 14
                    percentage: 64
                    results_count: 4
                    is_past_calculable: true
                    created_at: '2026-01-06T14:45:51.000000Z'
                    updated_at: '2026-01-20T09:12:03.000000Z'
                    deleted_at: null
                  - id: 7a1c8e2b-9d4f-4e6a-b3c7-5f8d2a1b9c0e
                    title: Faturamento trimestral
                    description: null
                    status: active
                    start_date: '2026-01-01'
                    end_date: null
                    periodicity: 90
                    type: composite
                    user_id: null
                    funnel_step_id: null
                    target: 100000
                    unit: currency
                    comparison_mode: target
                    progress: 48000
                    children:
                      - id: 1f3b6d9c-2e5a-4c8b-9a7d-3e6f1b2c4d5e
                        title: Vendas via funil de marketing
                        description: null
                        status: active
                        start_date: '2026-01-01'
                        end_date: null
                        periodicity: 90
                        type: funnel_steps_links
                        user_id: null
                        funnel_step_id: 310
                        target: 60000
                        unit: currency
                        comparison_mode: target
                        progress: 30000
                        progress_change_percentage: 0
                        percentage: 50
                        is_past_calculable: true
                        created_at: '2026-01-06T14:50:10.000000Z'
                        updated_at: '2026-01-20T09:12:03.000000Z'
                        deleted_at: null
                    progress_change_percentage: 8
                    percentage: 48
                    results_count: 1
                    is_past_calculable: false
                    created_at: '2026-01-06T15:02:44.000000Z'
                    updated_at: '2026-01-20T09:12:03.000000Z'
                    deleted_at: null
                meta:
                  current_page: 1
                  from: 1
                  last_page: 1
                  per_page: 30
                  to: 2
                  total: 2
                response: true
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````