Search Referral Campaigns Tool
search-referral-campaignsSearches authorized referral campaigns by name, status, message channel, and bounded performance fields. Use to search referral campaigns in the connected business. Returns query, count, total, campaigns, resolution, scope.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "search-referral-campaigns"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of campaigns to return. | |
| query | No | Campaign name, message, or channel. | |
| status | No | Campaign status. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Count for the returned result. | |
| query | Yes | Query used or returned by this tool. | |
| scope | Yes | Authorization scope of this result; data remains restricted to the connected business. | |
| total | Yes | Total for the returned result. | |
| campaigns | Yes | Bounded campaigns records returned by this tool. | |
| resolution | Yes | Resolution metadata; empty collections retain their existing JSON array representation. |