Listar metas avançadas

get

https://api.pipe.run/v1/advanced-goals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Endpoint utilizado para listar todas as metas avançadas cadastradas na conta do CRM PipeRun.

⚠️ Atenção!

Metas avançadas deve estar liberada para a sua conta utilizar.

Visibilidades

Tipo	Situação
Pública	Meta listada por todos usuários da conta
Envolvidos	Meta listada por quem criou a meta e os usuários envolvidos na mesma
Privada	Meta listada por quem criou a mesma

Obs.: Usuário responsável da conta tem acesso a todas as metas avançadas.

Query Params

show

int32

Defaults to 15

Número de itens na página de resultado. Máximo: 200

cursor

string

Defaults to ""

Hash da próxima página

sort

string

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

desc

boolean

Tipo de ordenação (quando o parâmetro sort for definido). Opções: true= Decrescente | false= Crescente

with

string

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

title

string

Título da meta

type

array of int32s

type

situation

int32

Situação da meta. Opções: 1= aberta | 2= encerrada | 3= programada

value

float

Valor total da meta

visibility

int32

Visibilidade da meta. Opções: 1= pública | 2= privada | 3= envolvidos

goal_for

int32

Meta por. Opções: 1= quantidade | 2= valor | 5= duração

created_by_id

int32

ID do usuário criador da meta

user_id

int32

ID do usuário envolvido na meta

activity_type_id

int32

ID do tipo de atividade (quando o parâmetro type for: 2= atividades)

origin_id

int32

ID da origem da oportunidade

segment_id

int32

ID do segmento da empresa

region_id

int32

ID da Região ou Microrregião da empresa ou pessoa

city_id

int32

ID da cidade da empresa ou pessoa

state

string

UF da cidade da empresa ou pessoa (Ex.: SP / RJ / RS)

tag_id

int32

ID da tag da oportunidade, empresa ou pessoa

pipeline_id

int32

ID do funil da oportunidade

stage_id

int32

ID da etapa da oportunidade

custom_field_id

array of int32s

ID do campo customizado

custom_field_id

start_at_start

date

Filtrar por metas com vigência inicial a partir da data informada (Ex.: start_at_start=2025-01-01). Padrão: aaaa-mm-dd

start_at_end

date

Filtrar por metas com vigência inicial até a data informada (Ex.: start_at_end=2025-12-31). Padrão: aaaa-mm-dd

end_at_start

date

Filtrar por metas com vigência final a partir da data informada (Ex.: end_at_start=2025-01-01). Padrão: aaaa-mm-dd

end_at_end

date

Filtrar por metas com vigência final até a data informada (Ex.: end_at_end=2025-12-31). Padrão: aaaa-mm-dd

created_at_start

date

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

created_at_end

date

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

updated_at_start

date

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

updated_at_end

date

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

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

⚠️ Atenção!

Visibilidades

200200