Ir para o conteúdo
Pipefácil

Listar negócios

Ver como MarkdownConfigurar agente
GET/api/v1/deals

Página de negócios visíveis ao membro da chave, ordenada pela criação mais recente. Sem status, inclui abertos, ganhos e perdidos. Mantenha os mesmos filtros ao reutilizar o cursor.

Exemplos

A URL usa o servidor de produção. Defina PIPEFACIL_API_KEY e as variáveis de caminho (como SEQ ou ID) com os identificadores reais. Ajuste o corpo antes de executar: requisições de escrita alteram dados do workspace.

cURL

curl --request GET \
  --url "https://pipefacil-server.matchsales.com.br/api/v1/deals" \
  --header "Authorization: Bearer $PIPEFACIL_API_KEY"
JavaScript
const response = await fetch(`https://pipefacil-server.matchsales.com.br/api/v1/deals`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PIPEFACIL_API_KEY}`,
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const text = await response.text();
const data = text ? JSON.parse(text) : null;
Python
import os
import json
import requests

response = requests.request(
    "GET",
    f"https://pipefacil-server.matchsales.com.br/api/v1/deals",
    headers={"Authorization": f"Bearer {os.environ['PIPEFACIL_API_KEY']}"},
)
response.raise_for_status()
data = response.json() if response.content else None

Parâmetros

NomeLocalTipoObrigatórioDescrição
pipelinequeryintegerNãoNúmero sequencial do funil dentro do workspace.
stageIdquerystringNão—
returningquerybooleanNão—
createdFromquerystringNãoyyyy-MM-dd
createdToquerystringNãoyyyy-MM-dd
sourcequerystringNãoSlug da origem do negócio, por exemplo, manual ou whatsapp.
responsibleUserIdsqueryarray de stringNãoPode ser repetido ou informado como lista separada por vírgulas.
tagIdsqueryarray de stringNãoPode ser repetido ou informado como lista separada por vírgulas.
searchquerystringNãoBusca por negócio, contato ou telefone.
limitqueryintegerNão—
cursorquerystringNãoCursor opaco retornado pela página anterior.
customFields[slug]querystringNãoFiltra pelo valor de um campo personalizado, usando o slug: customFields[budget]=high. O valor reservado __empty__ inclui negócios sem preenchimento (campo ausente, nulo, texto vazio ou lista vazia). Pode ser combinado com outros valores, usando a regra OU.
statusqueryarray de stringNãoSituações do negócio. Repita o parâmetro ou separe os valores por vírgula. Omitido: todas as situações.
customFieldRanges[slug][from]querystringNãoLimite inicial do intervalo de um campo de data. Substitua slug pela chave do campo.
customFieldRanges[slug][to]querystringNãoLimite final do intervalo de um campo de data. Combine com o limite inicial ou envie apenas um limite.

Respostas

200Sucesso
CampoTipoDescrição
dataobject—
data.itemsarray—
data.items[].idstring—
data.items[].seqinteger—
data.items[].namestring—
data.items[].valuenumber—
data.items[].currencystring—
data.items[].closeProbabilityinteger—
data.items[].sourcestring—
data.items[].statusstring—
data.items[].isReturningboolean—
data.items[].pipelineIdstring—
data.items[].stageIdstring—
data.items[].responsibleUserIdstring—
data.items[].coOwnerUserIdstringAceita null.
data.items[].lostReasonstringAceita null.
data.items[].notesstringAceita null.
data.items[].daysInStageinteger—
data.items[].tagsarray—
data.items[].tags[].idstring—
data.items[].tags[].namestring—
data.items[].tags[].colorstring—
data.items[].responsibleDealMember—
data.items[].responsible.userIdstring—
data.items[].responsible.namestringAceita null.
data.items[].coOwnerobjectAceita null.
data.items[].coOwner.userIdstring—
data.items[].coOwner.namestringAceita null.
data.items[].activeChannelsarray—
data.items[].lastMessageAtstringFormato: date-time. Aceita null.
data.items[].lastMessageTextstring—
data.items[].replyPendingboolean—
data.items[].propertiesobjectValores resolvidos dos campos personalizados.
data.items[].channelobjectAceita null.
data.items[].channelOverrideobjectAceita null.
data.items[].expectedCloseAtstringFormato: date-time. Aceita null.
data.items[].stageChangedAtstringFormato: date-time.
data.items[].closedAtstringFormato: date-time. Aceita null.
data.items[].returnSignaledAtstringFormato: date-time. Aceita null.
data.items[].contactobjectAceita null.
data.items[].stageobjectAceita null.
data.items[].companyobjectAceita null.
data.items[].createdAtstringFormato: date-time.
data.items[].updatedAtstringFormato: date-time.
data.items[].trackingobjectAceita null.
data.items[].tracking.utmContentstringAceita null.
data.items[].tracking.utmMediumstringAceita null.
data.items[].tracking.utmCampaignstringAceita null.
data.items[].tracking.utmSourcestringAceita null.
data.items[].tracking.utmTermstringAceita null.
data.items[].tracking.utmReferrerstringAceita null.
data.items[].tracking.referrerstringAceita null.
data.items[].tracking.gclientidstringAceita null.
data.items[].tracking.gclidstringAceita null.
data.items[].tracking.fbclidstringAceita null.
data.items[].tracking.metaLeadIdstringAceita null.
data.items[].tracking.fbpstringAceita null.
data.items[].tracking.fbcstringAceita null.
data.items[].tracking.clientIpAddressstringAceita null.
data.items[].tracking.clientUserAgentstringAceita null.
data.items[].tracking.ctwaClidstringAceita null.
data.items[].lostFromStageobjectAceita null.
data.items[].lostFromStage.idstring—
data.items[].lostFromStage.namestring—
data.items[].lostFromStage.pipelineIdstring—
data.items[].taskSummaryobjectResumo de tarefas quando habilitado na configuração do card. Aceita null.
data.items[].taskSummary.pendingCountinteger—
data.items[].taskSummary.overdueCountinteger—
data.items[].taskSummary.nextTaskobjectAceita null.
data.items[].taskSummary.nextTask.idstring—
data.items[].taskSummary.nextTask.titlestring—
data.items[].taskSummary.nextTask.dueAtstringFormato: date-time. Aceita null.
data.items[].taskSummary.nextTask.categoryNamestringAceita null.
data.items[].taskSummary.nextTask.categoryColorstringAceita null.
data.items[].lastActivityobjectÚltima atividade quando habilitada na configuração do card. Aceita null.
data.items[].lastActivity.idstring—
data.items[].lastActivity.typestring—
data.items[].lastActivity.occurredAtstringFormato: date-time.
data.items[].lastActivity.titlestring—
data.items[].lastActivity.bodystringAceita null.
data.items[].lastActivity.metaobject—
data.items[].lastActivity.actorobjectAceita null.
data.items[].lastActivity.actor.actorTypestring—
data.items[].lastActivity.actor.userIdstringAceita null.
data.items[].lastActivity.actor.userNamestringAceita null.
data.items[].lastActivity.actor.userAvatarUrlstringAceita null.
data.items[].lastActivity.actor.automationIdstringAceita null.
data.items[].lastActivity.actor.automationNamestringAceita null.
data.items[].lastActivity.actor.copilotActionIdstringAceita null.
data.items[].lastActivity.actor.apiKeyIdstringAceita null.
data.nextCursorstringAceita null.
data.hasMoreboolean—
messagestringAceita null.
Esquema OpenAPI
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/DealListItem"
          }
        },
        "nextCursor": {
          "type": "string",
          "nullable": true
        },
        "hasMore": {
          "type": "boolean"
        }
      }
    },
    "message": {
      "type": "string",
      "nullable": true
    }
  }
}
401Chave ausente, malformada, desconhecida, revogada ou expirada, ou membro emissor inativo.
CampoTipoDescrição
errorstring—
codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
requestIdstring—
detailsstringAceita null.
fieldErrorsarrayAceita null.
fieldErrors[].fieldstring—
fieldErrors[].messagestring—
Esquema OpenAPI
{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}
429Limite de requisições excedido por workspace ou IP.
CampoTipoDescrição
errorstring—
codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
requestIdstring—
detailsstringAceita null.
fieldErrorsarrayAceita null.
fieldErrors[].fieldstring—
fieldErrors[].messagestring—
Esquema OpenAPI
{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}
OpenAPI JSONMarkdown desta operação

Precisa de ajuda?

Encontrou um problema ou ficou com uma dúvida? Fale com a equipe pelo WhatsApp.

Chamar no WhatsApp
Pipefácil