GET api/integracaoPipefy?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&tokenPipefy={tokenPipefy}&phaseId={phaseId}&startCursor={startCursor}

Método para consultar informações dos Cards em fase de Pagamento.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CNPJ

Numero do CNPJ da empresa (polo) que receberá as informações.

string

Required

token

Código de acesso à API

string

Required

codigoEmpresa

Código identificador da empresa (polo)

integer

Required

tokenPipefy

Token Fornecido pelo Pipefy

string

Required

phaseId

Código da phase

integer

Required

startCursor

Parâmetro que indica de qual página ele deve começar

string

Required

Body Parameters

None.

Response Information

Resource Description

ClasseRetornoPipefy
NameDescriptionTypeAdditional information
CodigoRetorno

Código do retorno da API: 0 - erro || 1 - sucesso

integer

None.

MensagemRetorno

Mensagem de retorno da API

string

None.

ValorRetorno

Valor de retorno da API, quando houver

string

None.

ValorRetornoComplementar

Valor de retorno complementar da API, quando houver

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CodigoRetorno": 1,
  "MensagemRetorno": "sample string 2",
  "ValorRetorno": "sample string 3",
  "ValorRetornoComplementar": "sample string 4"
}

application/xml, text/xml

Sample:
<ClasseRetornoPipefy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models">
  <CodigoRetorno>1</CodigoRetorno>
  <MensagemRetorno>sample string 2</MensagemRetorno>
  <ValorRetorno>sample string 3</ValorRetorno>
  <ValorRetornoComplementar>sample string 4</ValorRetornoComplementar>
</ClasseRetornoPipefy>