v1
latestOpenAPI 3.1.02026-07-242200814.7 KBListar metas avançadas
Query parameters
Número de itens na página de resultado. Máximo: 200
Hash da próxima página
Critério de ordenação. Opções: id, title, visibility, type, goal_for, start_at, end_at, created_by_id, createdBy.name, created_at, updated_at, recurrence.id, recurrence.status, recurrence.type, recurrence.end_at
Tipo de ordenação (quando o parâmetro sort for definido). Opções: true= Decrescente | false= Crescente
Obter recursos com relações. Opções: pipelines, stages, users, users.user, users.team, recurrence, recurrence.repeatOnDays, createdBy, item, itemCategories, activityType, origin, region, city, segment, tags, customFields, value
Título da meta
Tipo de meta (Ex.: type[]=1&type[]=2). Opções: 1= oportunidade | 2= atividade | 3= forecast | 4= proposta | 5= ligação | 6= assinatura
Situação da meta. Opções: 1= aberta | 2= encerrada | 3= programada
Valor total da meta
Visibilidade da meta. Opções: 1= pública | 2= privada | 3= envolvidos
Meta por. Opções: 1= quantidade | 2= valor | 5= duração
ID do usuário criador da meta
ID do usuário envolvido na meta
ID do tipo de atividade (quando o parâmetro type for: 2= atividades)
ID da origem da oportunidade
ID do segmento da empresa
ID da Região ou Microrregião da empresa ou pessoa
ID da cidade da empresa ou pessoa
UF da cidade da empresa ou pessoa (Ex.: SP / RJ / RS)
ID da tag da oportunidade, empresa ou pessoa
ID do funil da oportunidade
ID da etapa da oportunidade
ID do campo customizado
Filtrar por metas com vigência inicial a partir da data informada (Ex.: start_at_start=2025-01-01). Padrão: aaaa-mm-dd
Filtrar por metas com vigência inicial até a data informada (Ex.: start_at_end=2025-12-31). Padrão: aaaa-mm-dd
Filtrar por metas com vigência final a partir da data informada (Ex.: end_at_start=2025-01-01). Padrão: aaaa-mm-dd
Filtrar por metas com vigência final até a data informada (Ex.: end_at_end=2025-12-31). Padrão: aaaa-mm-dd
Filtrar por metas com data de criação a partir da data e hora informada (Ex.: created_at_start=2025-01-01 00:00:00). Padrão: aaaa-mm-dd hh:mm:ss
Filtrar por metas com data de criação até a data e hora informada (Ex.: created_at_end=2025-12-31 23:59:59). Padrão: aaaa-mm-dd hh:mm:ss
Filtrar por metas com data de atualização a partir da data e hora informada (Ex.: updated_at_start=2025-01-01 00:00:00). Padrão: aaaa-mm-dd hh:mm:ss
Filtrar por metas com data de atualização até a data e hora informada (Ex.: updated_at_end=2025-12-31 23:59:59). Padrão: aaaa-mm-dd hh:mm:ss
Response
200
Example response
{
"success": true,
"message": "OK",
"data": [
{
"id": 1,
"account_id": 1,
"visibility": 1,
"type": 5,
"goal_for": 5,
"title": "Teste 123",
"observation": "Meta teste 123",
"type_of_period": 8,
"start_at": "2025-01-01",
"end_at": "2025-12-31",
"created_by_id": 1,
"situation": 1,
"created_at": "2025-01-01 08:30:00",
"updated_at": "2025-02-01 09:30:30",
"deal_status": [
"open"
],
"call_relevance": [
"import"
],
"active": true,
"pipelines": [
{
"id": 1,
"account_id": 1,
"funnel_type_name": "Vendas",
"user_id": 1,
"name": "Teste 123",
"description": "Funil de teste",
"visibility": 2,
"created_at": "2025-01-01 07:30:00",
"updated_at": "2025-02-01 08:30:00"
}
],
"tags": [
{
"id": 1,
"account_id": 1,
"user_id": 1,
"name": "Teste 123",
"color": "danger",
"belongs": 1,
"active": true,
"created_at": "2025-01-01 07:45:00",
"updated_at": "2025-02-01 08:45:00"
}
],
"users": [
{
"id": 1,
"account_id": 1,
"goal_id": 1,
"user_id": 1,
"value": 10000,
"created_at": "2025-01-01 08:30:00",
"updated_at": "2025-02-01 09:30:30",
"user": {
"id": 1,
"account_id": 1,
"name": "Teste 123"
}
}
]
}
],
"meta": {
"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1
}
}