Skip to main content
GET
Listar metas

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[title]
string

Filtra pelo título da meta (correspondência parcial, sem diferenciar maiúsculas).

filter[status]
enum<string>

Filtra pelo status exato. Valores aceitos: active, inactive, completed.

Available options:
active,
inactive,
completed
filter[type]
string

Filtra pelo tipo exato. Valores aceitos: manual, projects_created, projects_created_by_user, funnel_steps_links, funnel_steps_links_by_user, composite.

filter[comparison_mode]
string

Filtra pelo modo de comparação exato. Valores aceitos: target (atingir o alvo), limit (não ultrapassar o alvo).

filter[periodicity]
string

Filtra pela periodicidade exata, em dias. Use 0 para as metas que apuram o intervalo inteiro de uma vez.

filter[user_id]
string

Filtra as metas restritas ao usuário informado (ID UUID). Só retorna metas dos tipos projects_created_by_user e funnel_steps_links_by_user.

filter[funnel_step_id]
string

Filtra as metas que apuram a etapa de funil informada (ID numérico). Só retorna metas dos tipos funnel_steps_links e funnel_steps_links_by_user.

filter[start_date_gte]
string

Retorna as metas com data de início maior ou igual à data informada (YYYY-MM-DD).

filter[end_date_lte]
string

Retorna as metas com data de término menor ou igual à data informada (YYYY-MM-DD).

filter[trashed]
string

Controla as metas removidas. Valores aceitos: with (inclui as removidas), only (apenas as removidas). Sem o parâmetro, as removidas ficam de fora.

sort
string

Ordenação: nome do campo para crescente ou prefixado com '-' para decrescente; vários campos separados por vírgula. Campos aceitos: title, status, created_at, updated_at, start_date, end_date, target, progress, periodicity. Padrão: status,-created_at.

page
string

Número da página. Padrão 1.

perPage
string

Quantidade de metas por página. Padrão 30, máximo 100.

Response

Sucesso

Página de metas com os metadados da paginação.

response
boolean

Indicador de sucesso da requisição. Sempre true nas respostas bem-sucedidas.

goals
object[]

Metas da página.

meta
object

Metadados da paginação.