Botszap
    Contatos
    • Sessões
    • Contatos
    • Listar contatos
      GET
    • Obter contato
      GET
    • Criar novo contato
      POST
    • Atualizar contato
      PUT

      Listar contatos

      Em desenvolvimento
      GET
      https://api.botszap.com.br/api/v1/contacts/
      Lista todas as sessões ativas e/ou desativadas

      Requisição

      Authorization
      API Key
      Adicionar parâmetro em header
      x-api-key
      Exemplo:
      x-api-key: ********************
      or
      Parâmetros de Consulta

      Exemplos de Requisição

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location 'https://api.botszap.com.br/api/v1/contacts/?page=1&size=50&searchTerm=1' \
      --header 'x-api-key: <api-key>'

      Respostas

      🟢200Lista de contatos
      application/json
      Bodyapplication/json

      Exemplo
      {
          "page": 1,
          "pageSize": 10,
          "total": 100,
          "totalPages": 10,
          "sessions": [
              {
                  "contactId": "f9eeed77-2d61-44a9-a459-cac8017091b0",
                  "name": "João das Neves",
                  "phoneNumber": "5511999991111"
              }
          ]
      }
      Modificado em 2026-10-09 11:39:13
      Próxima página
      Obter contato
      Built with