Skip to main content
GET
/
api
/
v1
/
rules
List campaign contact rules
curl --request GET \
  --url https://{subdomain}.mihu.ai/api/v1/rules \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Rules retrieved successfully",
  "data": {
    "current_page": 1,
    "last_page": 3,
    "per_page": 15,
    "total": 42,
    "data": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Aggressive call rule",
        "max_calls_per_day": 3,
        "max_total_calls": 10,
        "retry_interval_minutes": 120,
        "start_time": "09:00:00",
        "end_time": "18:00:00",
        "dnc_check": true,
        "remove_on_opt_out": true,
        "escalation_after_failed_attempts": 0,
        "escalation_type": "<string>",
        "escalation_target": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.mihu.ai/llms.txt

Use this file to discover all available pages before exploring further.

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. No hard cap, but values above 100 are discouraged.

​
search
string

Case-insensitive partial match against rule name, escalation_type, or escalation_target.

​
type
enum<string>

Filter by rule type. 'call' rules schedule retried calls within working hours. 'text' rules are one-shot WhatsApp/SMS sends.

Available options:
call,
text

Response

200 - application/json

Paginated list of rules.

​
success
boolean
Example:

true

​
message
string
Example:

"Rules retrieved successfully"

​
data
object

Paginator payload.