Ir para o conteúdo
Pipefácil

Consultar negócio

Ver como MarkdownConfigurar agente
GET/api/v1/deals/{seq}

Retorna um negócio visível pelo seu número sequencial no workspace.

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/$SEQ" \
  --header "Authorization: Bearer $PIPEFACIL_API_KEY"
JavaScript
const response = await fetch(`https://pipefacil-server.matchsales.com.br/api/v1/deals/${process.env.SEQ}`, {
  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/{os.environ['SEQ']}",
    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
seqpathintegerSimNúmero sequencial do negócio dentro do workspace.

Respostas

200Sucesso
CampoTipoDescrição
dataDealListItemNegócio detalhado retornado na listagem ou consulta, com relações associadas.
data.idstring—
data.seqinteger—
data.namestring—
data.valuenumber—
data.currencystring—
data.closeProbabilityinteger—
data.sourcestring—
data.statusstring—
data.isReturningboolean—
data.pipelineIdstring—
data.stageIdstring—
data.responsibleUserIdstring—
data.coOwnerUserIdstringAceita null.
data.lostReasonstringAceita null.
data.notesstringAceita null.
data.daysInStageinteger—
data.tagsarray—
data.tags[].idstring—
data.tags[].namestring—
data.tags[].colorstring—
data.responsibleDealMember—
data.responsible.userIdstring—
data.responsible.namestringAceita null.
data.coOwnerobjectAceita null.
data.coOwner.userIdstring—
data.coOwner.namestringAceita null.
data.activeChannelsarray—
data.lastMessageAtstringFormato: date-time. Aceita null.
data.lastMessageTextstring—
data.replyPendingboolean—
data.propertiesobjectValores resolvidos dos campos personalizados.
data.channelobjectAceita null.
data.channelOverrideobjectAceita null.
data.expectedCloseAtstringFormato: date-time. Aceita null.
data.stageChangedAtstringFormato: date-time.
data.closedAtstringFormato: date-time. Aceita null.
data.returnSignaledAtstringFormato: date-time. Aceita null.
data.contactobjectAceita null.
data.stageobjectAceita null.
data.companyobjectAceita null.
data.createdAtstringFormato: date-time.
data.updatedAtstringFormato: date-time.
data.trackingobjectAceita null.
data.tracking.utmContentstringAceita null.
data.tracking.utmMediumstringAceita null.
data.tracking.utmCampaignstringAceita null.
data.tracking.utmSourcestringAceita null.
data.tracking.utmTermstringAceita null.
data.tracking.utmReferrerstringAceita null.
data.tracking.referrerstringAceita null.
data.tracking.gclientidstringAceita null.
data.tracking.gclidstringAceita null.
data.tracking.fbclidstringAceita null.
data.tracking.metaLeadIdstringAceita null.
data.tracking.fbpstringAceita null.
data.tracking.fbcstringAceita null.
data.tracking.clientIpAddressstringAceita null.
data.tracking.clientUserAgentstringAceita null.
data.tracking.ctwaClidstringAceita null.
data.lostFromStageobjectAceita null.
data.lostFromStage.idstring—
data.lostFromStage.namestring—
data.lostFromStage.pipelineIdstring—
data.taskSummaryobjectResumo de tarefas quando habilitado na configuração do card. Aceita null.
data.taskSummary.pendingCountinteger—
data.taskSummary.overdueCountinteger—
data.taskSummary.nextTaskobjectAceita null.
data.taskSummary.nextTask.idstring—
data.taskSummary.nextTask.titlestring—
data.taskSummary.nextTask.dueAtstringFormato: date-time. Aceita null.
data.taskSummary.nextTask.categoryNamestringAceita null.
data.taskSummary.nextTask.categoryColorstringAceita null.
data.lastActivityobjectÚltima atividade quando habilitada na configuração do card. Aceita null.
data.lastActivity.idstring—
data.lastActivity.typestring—
data.lastActivity.occurredAtstringFormato: date-time.
data.lastActivity.titlestring—
data.lastActivity.bodystringAceita null.
data.lastActivity.metaobject—
data.lastActivity.actorobjectAceita null.
data.lastActivity.actor.actorTypestring—
data.lastActivity.actor.userIdstringAceita null.
data.lastActivity.actor.userNamestringAceita null.
data.lastActivity.actor.userAvatarUrlstringAceita null.
data.lastActivity.actor.automationIdstringAceita null.
data.lastActivity.actor.automationNamestringAceita null.
data.lastActivity.actor.copilotActionIdstringAceita null.
data.lastActivity.actor.apiKeyIdstringAceita null.
messagestringAceita null.
Esquema OpenAPI
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/DealListItem"
    },
    "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"
  ]
}
404Recurso não encontrado ou fora da visibilidade do membro.
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