Skip to main content
GET
/
api
/
v1
/
pools
List contact pools
curl --request GET \
  --url https://{subdomain}.mihu.ai/api/v1/pools \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Pools retrieved successfully",
  "data": {
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "total": 22,
    "data": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "max_parallel_items": 123,
        "max_retries": 123,
        "is_active": true,
        "contacts_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:1

1-based page number. Default 1.

​
per_page
integer
default:15

Items per page. Default 15.

​
search
string

Case-insensitive partial match against pool name, description, or type.

​
type
enum<string>

Filter by processing order. FIFO = oldest pending first; LIFO = newest pending first; Parallel = up to max_parallel_items concurrent, priority-ordered.

Available options:
FIFO,
LIFO,
Parallel
​
is_active
boolean

Filter by active flag. Inactive pools cannot be selected by new campaigns.

Response

200 - application/json

Paginated list of pools. Each row includes contacts_count (no per-row status breakdown — use GET /pools/{uuid} for that).

​
success
boolean
Example:

true

​
message
string
Example:

"Pools retrieved successfully"

​
data
object

Paginator payload.