Get Audience Leads

curl --request GET \
  --url https://api.usewave.co/api/v1/audiences/{id}/leads \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.usewave.co/api/v1/audiences/{id}/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://api.usewave.co/api/v1/audiences/{id}/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://api.usewave.co/api/v1/audiences/{id}/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.usewave.co/api/v1/audiences/{id}/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

{
  "data": [
    {}
  ],
  "page": 1,
  "limit": 15,
  "total": 320,
  "total_pages": 22,
  "search": "<string>",
  "filters": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

GET

api

audiences

{id}

leads

Get Audience Leads

curl --request GET \
  --url https://api.usewave.co/api/v1/audiences/{id}/leads \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.usewave.co/api/v1/audiences/{id}/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://api.usewave.co/api/v1/audiences/{id}/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://api.usewave.co/api/v1/audiences/{id}/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.usewave.co/api/v1/audiences/{id}/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

{
  "data": [
    {}
  ],
  "page": 1,
  "limit": 15,
  "total": 320,
  "total_pages": 22,
  "search": "<string>",
  "filters": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

Authorizations

Authorization

string

header

required

Enter your API key: wave_live_<token>

Path Parameters

string

required

Query Parameters

page

integer | null

default:1

Page number (starts at 1)

Required range: x >= 1

limit

integer | null

default:15

Items per page (max 100)

Required range: 1 <= x <= 100

sort_field

string | null

Field name to sort by (e.g. 'follower_count' or 'username')

sort_order

string | null

Sort direction: 'asc' or 'desc'

Pattern: ^(asc|desc)$

string | null

Search term to filter leads by username or bio

filters

string | null

JSON-encoded string of column filter criteria. Example: '{"follower_count": {"min": 500, "max": 50000}, "is_verified": true, "account_type": "Business"}'

Response

Successful Response

Paginated list of leads with search and filter state.

data

Data · object[]

required

Array of extracted Instagram profile objects

page

integer

required

Current page number

Example:

1

limit

integer

required

Page size limit

Example:

15

total

integer

required

Total leads matching search/filter criteria

Example:

320

total_pages

integer

required

Total pages available

Example:

22

string | null

Search term applied

filters

any | null

Column filter rules applied. Can be passed as a JSON-encoded string in query params. Example: '{"follower_count": {"min": 500, "max": 50000}, "is_verified": true, "account_type": "Business"}'

Getting Started

Endpoints

Get Audience Leads

Authorizations

Path Parameters

Query Parameters

Response