Hunt List

The Hunt List object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped. Tenant API keys must include tenant=CANISTRACCI; writes require a writable API key.

Object Summary

Property	Value
Object	`huntlist`
Primary path	`/huntlists`
ID field	`hu_id`
Label field	`hu_name`
Primary source table	`hu_huntlists`
Required on create	`hu_name`
Path aliases	`/huntlists`

Endpoint Patterns

Action	Example pattern
List	`GET https://pbx.example.com/pbx/openapi.php/huntlists?tenant=CANISTRACCI`
Get by ID	`GET https://pbx.example.com/pbx/openapi.php/huntlists/OBJECT_ID?tenant=CANISTRACCI`
Create	`POST https://pbx.example.com/pbx/openapi.php/huntlists?tenant=CANISTRACCI`
Update	`PATCH https://pbx.example.com/pbx/openapi.php/huntlists/OBJECT_ID?tenant=CANISTRACCI`
Delete	`DELETE https://pbx.example.com/pbx/openapi.php/huntlists/OBJECT_ID?tenant=CANISTRACCI`

Accepted Field Aliases

Request field	Source field
`name`	`hu_name`
`number`	`hu_number`
`type`	`hu_type`
`ringtime`	`hu_ringtime`

Destination Fields

Destination fields accept one destination string or an array of destination strings such as EXT-100, VOICEMAIL-100, or another supported destination type and ID pair.

Destination type	Accepted aliases
`HUNTLIST`	`extensions`, `members`, `huntlist`
`HUNTLIST-TIMEOUT`	`timeout`, `huntlist_timeout`

Examples

List Hunt Lists

Returns the hunt lists visible to the key and scope.

curl -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/huntlists?tenant=CANISTRACCI"

Get Hunt List

Reads one object by its internal ID.

curl -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/huntlists/OBJECT_ID?tenant=CANISTRACCI"

Create Hunt List

Creates a new object. Use the short aliases shown above or the source field names.

curl -X POST \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Docs API Hunt List",
  "number": "820",
  "type": "RINGALL",
  "ringtime": 20
}' \
  "https://pbx.example.com/pbx/openapi.php/huntlists?tenant=CANISTRACCI"

Edit Hunt List

Updates only the supplied fields.

curl -X PATCH \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ringtime": 25
}' \
  "https://pbx.example.com/pbx/openapi.php/huntlists/OBJECT_ID?tenant=CANISTRACCI"

Delete Hunt List

Deletes the object. Check references before deleting configuration used by routing or reporting.

curl -X DELETE \
  -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/huntlists/OBJECT_ID?tenant=CANISTRACCI"

Hunt List Destination

Updates the HUNTLIST destination. The same value can also be sent inside a destinations object.

curl -X PATCH \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "extensions": [
    "EXT-100"
  ]
}' \
  "https://pbx.example.com/pbx/openapi.php/huntlists/OBJECT_ID?tenant=CANISTRACCI"

Hunt List TIMEOUT Destination

Updates the HUNTLIST-TIMEOUT destination. The same value can also be sent inside a destinations object.

curl -X PATCH \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "timeout": [
    "EXT-100"
  ]
}' \
  "https://pbx.example.com/pbx/openapi.php/huntlists/OBJECT_ID?tenant=CANISTRACCI"

Common Errors

Error	Meaning
`missing_api_key`	No API key was supplied in the query string, `X-API-Key`, or bearer token.
`invalid_api_key`	The supplied key does not match the tenant or global API key.
`tenant_required`	A tenant code is required for tenant-scoped writes or tenant-key reads.
`read_only_api_key`	The key can read data but cannot create, update, or delete objects.
`missing_required_field`	A required create field is missing.