Associações de Pessoas

Retornar as associações ao cliente

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: POST /api/v1/cliente/autenticacao (documento e senha do cliente) ou POST /api/v1/cliente/autenticacao/sindico (síndicos). ⚠️ O token de integração das APIs v2/v3 (POST /api/v3/auth/token) não é válido para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.

get/associacoes

Request

  • Base URL
    https://integracao.cvcrm.com.br/api/v1/cliente
  • URL
    https://integracao.cvcrm.com.br/api/v1/cliente/associacoes
  • Auth
    HTTP bearer

Query parameters

idAssociacaointeger

id de associação para retorna somente uma associação

offsetinteger

registro inicial

limitinteger

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

Response

Listagem de Associações

totalinteger
offsetinteger
limitstring nullable

Example response

{
  "total": 1,
  "associacoes": [
    {
      "idassociacao": 3549,
      "nome_associado": "MATHEUS CARDOSO MARTINS",
      "tipo_associacao": {
        "idtipo": 12,
        "nome": "Inquilino"
      },
      "unidades": [
        {
          "idunidade": 16108,
          "nome": "APTO 101",
          "previsao_entrega": "2021-02-01",
          "bloco": {
            "idbloco": 6,
            "nome": "Bloco Cursos"
          },
          "etapa": {
            "idetapa": 4,
            "nome": "Única"
          },
          "empreendimento": {
            "idempreendimento": 3,
            "nome": "9201 - Varandas do Garcia (CONF AVENDRE)",
            "foto": {
              "nome": "apartamentos-laterais-do-golden-barro-vermelho-em-vitoria-es",
              "tipo": "image/jpeg",
              "tamanho": 32366,
              "url": "https://localhost.cvcrm.com.br/api/get/imagens/empreendiment"
            }
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.