search
Find things by name, slug, domain, email or the last four characters of a license key across every area this token can read: products, installations (by domain), licenses (key ending, or customer email with pii:read), contacts and demo leads (need pii:read), campaigns, members. Returns typed references (type, id, label) to open with the matching get_/list_ tool, plus which areas were searched and which were skipped and why. Costs 3 rate-limit units.
- Server: Organization server
- Scope: Any valid token
- Read-only: yes
Input
{
"properties": {
"query": {
"description": "At least 2 characters.",
"minLength": 2,
"maxLength": 255,
"type": "string"
}
},
"type": "object",
"required": [
"query"
]
}Output (structuredContent)
{
"properties": {
"as_of": {
"type": "string"
},
"results": {
"items": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"label_text": {
"type": "string"
},
"detail": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
},
"searched_areas": {
"items": {
"type": "string"
},
"type": "array"
},
"skipped_areas": {
"type": "array"
}
},
"type": "object",
"required": [
"as_of",
"results",
"searched_areas",
"skipped_areas"
]
}