Skip to main content
GET
/
api
/
v1
/
pools
/
{uuid}
/
contacts
List contacts in a pool
curl --request GET \
  --url https://{subdomain}.mihu.ai/api/v1/pools/{uuid}/contacts \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{subdomain}.mihu.ai/api/v1/pools/{uuid}/contacts"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{subdomain}.mihu.ai/api/v1/pools/{uuid}/contacts', 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://{subdomain}.mihu.ai/api/v1/pools/{uuid}/contacts",
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://{subdomain}.mihu.ai/api/v1/pools/{uuid}/contacts"

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://{subdomain}.mihu.ai/api/v1/pools/{uuid}/contacts")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/pools/{uuid}/contacts")

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
{
  "success": true,
  "message": "Pool contacts retrieved successfully",
  "data": {
    "pool_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_page": 1,
    "last_page": 4,
    "per_page": 25,
    "total": 87,
    "data": [
      {
        "contact_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "phone_number": "<string>",
        "email": "<string>",
        "status": "<string>",
        "priority": 123,
        "retry_count": 123,
        "started_at": "2023-11-07T05:31:56Z",
        "completed_at": "2023-11-07T05:31:56Z",
        "failed_at": "2023-11-07T05:31:56Z",
        "next_retry_at": "2023-11-07T05:31:56Z",
        "notes": "<string>",
        "added_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

uuid
string<uuid>
required

UUID of the pool whose members to list.

Query Parameters

page
integer
default:1

1-based page number. Default 1.

per_page
integer
default:25

Items per page. Default 25.

Case-insensitive partial match against the underlying contact's name, surname, email, or phone_number. Combine with status= to filter further.

status
enum<string>

Filter by ContactPoolItem status. Pending = waiting to be picked up. Processing/In_Call = currently being attempted. Retrying = failed once, awaiting retry window. Scheduled = queued for a specific future retry time. Completed/Failed/Skipped = terminal.

Available options:
Pending,
Processing,
Completed,
Failed,
Retrying,
Scheduled,
In_Call,
Skipped

Response

Paginated pool members.

success
boolean
Example:

true

message
string
Example:

"Pool contacts retrieved successfully"

data
object

Paginator payload.