v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Gestões de Cessão

get gestão de cessão

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta API é responsável por retornar todas as gestões de cessão cadastradas no CV.

get/gestoes-cessao

Query parameters

offsetinteger

Registro inicial

limitinteger
Example:30

Quantidade de registros (caso não passe retorna todos)

idgestaocessaointeger
Example:20

Código de indentificação da gestão da cessão

idreservainteger
Example:2001

Código de indentificação da reserva

idpessoainteger
Example:9

Código de indentificação da pessoa

Headers

emailstring required
Example:email@email.com

Email de autenticação no CV

tokenstring required
Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Token de autenticação no CV

Response

Resposta do get Gestões de Cessão

totalinteger

Total de resultados

limitinteger

Limite de itens no conteúdo da resposta

offsetinteger

Offset do início dos resultados

totalConteudointeger

Total de resultados no conteúdo da resposta

Example response

{
  "total": 30,
  "limit": 30,
  "offset": 0,
  "totalConteudo": 30,
  "gestoes-cessao": [
    {
      "idgestaocessao": 10,
      "data_cad": "2023-07-24",
      "idsituacao": 1,
      "situacao": "Início",
      "idreserva": 2001,
      "idunidade": 100,
      "unidade": "AP 101",
      "idbloco": 4,
      "bloco": "Bloco A",
      "idetapa": 2,
      "etapa": "Única",
      "idempreendimento": 2,
      "empreendimento": "Única",
      "vencimento": "2023-07-24 13:48:13",
      "pessoa": {
        "idpessoa": 20,
        "nome": "Pessoa CV",
        "documento": "1234567899"
      },
      "documentos": [
        {
          "idtipo": 1,
          "tipo": "RG",
          "situacao": "Reprovado",
          "arquivo_nome": "rg.jpg"
        }
      ],
      "mensagens": [
        {
          "usuario": "Gestor CV",
          "mensagem": "Mensagem teste"
        }
      ],
      "contratos": [
        {
          "contrato": "Termo de consentimento",
          "assinado": "2023-07-24 13:48:13",
          "validado": "2023-07-24 13:48:13"
        }
      ]
    }
  ]
}