enhancedocs
For agentsOpen Enhance
Reference / person.recipients.search

Enhance documentation

person.recipients.search

Find people who can be invited by matching a name or email.

Markdown

person.recipients.search

query read

Use when current person state is missing from the task context.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.

Input

Show complete JSON Schema
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "properties": {
  "query": {
   "type": "string",
   "minLength": 1,
   "maxLength": 200
  }
 },
 "required": [
  "query"
 ],
 "additionalProperties": false
}

Example

Show example input
{
 "query": "x"
}

Result

Returns a typed person.recipients.search result from the Enhance API without transport-specific prose.

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Use the returned identifiers and version in the next person operation.

Compatibility: 0d2a83a6bcd28dffdc20e18d93a994a46be5bdeeb193ab4941c2926fa569a317.