v1

latestOpenAPI 3.1.02026-08-044330906.8 KB

Consultar Contas

Endpoint público com paginação para consulta das contas cadastradas no Wake OMS.

get/pub/contas

Query parameters

contastring

Nome da conta. Se estiver vazio, todas as contas serão retornadas.

inativoboolean

Indica se devem ser retornadas apenas as contas ativas ou inativas. Se estiver nulo, o filtro não será aplicado.

administrativaboolean

Indica se devem ser retornadas apenas as contas administrativas ou não. Se estiver nulo, o filtro não será aplicado.

paginainteger

Indica a página que deseja ser buscada. Obs.: Caso o parâmetro não for especificado ou menor que 1, retornará como default a página 1

Headers

Acceptstring
Content-Typestring

Response

200

mensagemstring

Example response

{
  "mensagem": "Sucesso",
  "dados": {
    "lista": [
      {
        "conta": "string",
        "site": "string",
        "chave": "string",
        "email": "string",
        "inativo": "bool",
        "acessoAdmin": "bool",
        "nomeRemetente": "string",
        "endereco": "string",
        "numero": "string",
        "complemento": "string",
        "bairro": "string",
        "cidade": "string",
        "uf": "string",
        "pais": "string",
        "cep": "string",
        "contaPrincipal": "string",
        "cnpj": "string",
        "tipoConta": "string",
        "telefone": "string",
        "inscricaoEstadual": "string"
      }
    ],
    "pagina": 1,
    "porPagina": 50,
    "total": 1,
    "paginas": 1
  }
}