Listar leads

Listar todos os leads do usuário autenticado

GET /user/leads

Listar leads

cURL

curl --request GET \
  --url https://app.mayahub.ai/api/user/leads \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.mayahub.ai/api/user/leads"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.mayahub.ai/api/user/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.mayahub.ai/api/user/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mayahub.ai/api/user/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.mayahub.ai/api/user/leads")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mayahub.ai/api/user/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200 Response

[
  {
    "id": 1,
    "campaign_id": 1,
    "phone_number": "[phone]",
    "variables": {
      "customer_name": "John Doe",
      "email": "[e-mail]"
    },
    "status": "created",
    "created_at": "2025-06-30 11:18:04",
    "updated_at": "2025-06-30 11:18:04",
    "campaign": {
      "id": 1,
      "name": "My new campaign"
    },
    "secondary_contacts": [
      {
        "id": 2,
        "phone_number": "[phone]",
        "variables": {
          "customer_name": "Jane Doe Secondary",
          "email": "[e-mail]"
        },
        "status": "created",
        "created_at": "2025-06-30 11:18:04",
        "updated_at": "2025-06-30 11:18:04"
      }
    ]
  }
]

Este endpoint permite listar todos os leads pertencentes ao usuário autenticado.

Campos de resposta

leads · array

Show Propriedades

id · integer

O ID do lead

campaign_id · integer

O ID da campanha à qual este lead pertence

phone_number · string

O número de telefone do lead no formato E.164

variables · object

As variáveis associadas ao lead

status · string

O status do lead

created_at · string

A data de criação do lead

updated_at · string

A data de atualização do lead

campaign · object

As informações da campanha

Show Propriedades da Campanha

id · integer

O ID da campanha

name · string

O nome da campanha

secondary_contacts · array

Array de contatos secundários associados a este lead

Show Propriedades de secondary_contacts

id · integer

O ID do lead de contato secundário

phone_number · string

O número de telefone do contato secundário no formato E.164

variables · object

As variáveis associadas ao contato secundário

status · string

O status do contato secundário

created_at · string

A data de criação do contato secundário

updated_at · string

A data de atualização do contato secundário

200 Response

[
  {
    "id": 1,
    "campaign_id": 1,
    "phone_number": "[phone]",
    "variables": {
      "customer_name": "John Doe",
      "email": "[e-mail]"
    },
    "status": "created",
    "created_at": "2025-06-30 11:18:04",
    "updated_at": "2025-06-30 11:18:04",
    "campaign": {
      "id": 1,
      "name": "My new campaign"
    },
    "secondary_contacts": [
      {
        "id": 2,
        "phone_number": "[phone]",
        "variables": {
          "customer_name": "Jane Doe Secondary",
          "email": "[e-mail]"
        },
        "status": "created",
        "created_at": "2025-06-30 11:18:04",
        "updated_at": "2025-06-30 11:18:04"
      }
    ]
  }
]