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 por título (correspondência parcial).

filter[status]
enum<string>

Filtra pelo status exato: active, inactive ou completed.

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

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

filter[comparison_mode]
string

Filtra pelo modo de comparação: target (atingir a meta) ou limit (não ultrapassar).

filter[periodicity]
string

Filtra pela periodicidade exata, em dias.

filter[user_id]
string

Filtra metas cujo user_id corresponde ao ID do usuário informado.

filter[funnel_step_id]
string

Filtra metas cujo funnel_step_id corresponde ao ID da etapa de funil informada.

filter[start_date_gte]
string

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

filter[end_date_lte]
string

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

filter[trashed]
string

Controla metas removidas (soft delete): with inclui removidas, only retorna apenas removidas, without (padrão) as ignora.

sort
string

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.

page
string

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

perPage
string

Itens por página. Padrão 30, máximo 100.

Response

200 - application/json

Sucesso

goals
object[]
meta
object
response
boolean