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"]}

Example

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

Result

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

  • recipients (required): Returned field recipients.
Show complete result JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"recipients":{"maxItems":5,"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"person"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"displayName":{"type":"string","minLength":1,"maxLength":120},"initials":{"type":"string","minLength":1,"maxLength":4},"avatarUrl":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["kind","personId","displayName","initials","email"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"email"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["kind","email"],"additionalProperties":false}]}}},"required":["recipients"],"additionalProperties":false}

Example result

Show example result 
{
 "recipients": []
}

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.

Versions

Compatibility: 61b5c75c4d9bc70a3b497b5065007c6a40abcab4ccb3749fe7f85741a47c6066.

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.