v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Localidade

Listar localidades disponíveis

🔒 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)

Retorna regiões, cidades ou localidades configuradas para o módulo.

Utilização funcional:

Popular dropdowns no app e auxiliar na triagem de assistências por área.

get/v1/relacionamento/assistencias/localidade

Query parameters

offsetinteger

registro inicial

limitinteger

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

Headers

emailstring required

Example:email@email.com

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Response

Localidades Existentes

totalinteger

offsetinteger

limitinteger

Example response

{
  "total": 1,
  "limit": 30,
  "localidades": [
    {
      "idlocalidade": 1,
      "nome": "Aracaju",
      "data_cadastro": "2018-06-29 15:48:01",
      "descricao": "Descrição de localidade teste"
    }
  ]
}