Enhance documentation

enhance-dev person recipients search

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

enhance-dev person recipients search

enhance-dev person recipients search [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--query <string>`	Yes	None	Name or email text to match against available recipients.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.

Input

This command presents the capability person.recipients.search. It has read effect and none idempotency.

Show complete input JSON Schema

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

Output

This command writes JSON records to standard output. Returns a typed person.recipients.search result from the Enhance API without transport-specific prose.

Show complete output 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}

Examples

enhance-dev person recipients search --query <string>

Show example input

{
 "query": "x"
}

Show example output

{
 "recipients": []
}

Exit behaviour

Exit code	Meaning
`0`	The command succeeded.
`1`	The command failed for another reason (`INTERNAL`). A write may have an unknown outcome.
`2`	The command line was malformed. Nothing ran.
`3`	The API refused the input (`BAD_REQUEST`).
`4`	The credential is missing or expired (`UNAUTHORIZED`).
`5`	The API refused the request (`FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `RATE_LIMITED`).
`6`	A batch finished only in part. Retry with the same `--client-token`.

Versions

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