Search query using field:value syntax. Multiple conditions separated by spaces are ANDed together.

URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples in this documentation show human-readable syntax for clarity.

Syntax

Examples

• john — exact match for "john" in searchable fields
• john — contains "john" in searchable fields
• name:smith — name contains "smith" (case-insensitive)
• email:*@example.com — email ends with "@example.com"
• status:approved — exact match on status field
• status:approved,pending — status is "approved" OR "pending"
• income:>=1000 — income greater than or equal to 1000
• created:>2024-01-01 — created after January 1, 2024
• status:approved income:>=1000 — approved AND income >= 1000 (multiple conditions)
• -status:denied — exclude records with status "denied"
• -deletedAt:* — only records where deletedAt does not exist
• applicant.state:CA — nested field filter

URL Encoding Reference

When manually constructing URLs, encode these characters:

Example: `` Human-readable: q=status:approved income:>=1000 URL-encoded: q=status%3Aapproved%20income%3A%3E%3D1000 ``

Maximum number of items to return (1-100).

Number of items to skip before collecting results.

Comma-separated list of fields to sort the response by. Prefix a field with - for descending order. The first field is the primary sort; subsequent fields are tie-breakers in declaration order.

URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples below show human-readable syntax for clarity.

Which fields a given list endpoint allows is declared in the operation's x-sortable.fields extension. Sending a field name not present in that list returns 400 FIELD_NOT_SORTABLE. Sending a field name that doesn't exist on the resource schema returns 400 INVALID_SORT_FIELD. When this parameter is omitted, the operation's x-sortable.default (if declared) is applied; otherwise no client-driven sort is applied. A configured tie-breaker (default id) is always appended for stable pagination.

See api-patterns.yaml#sorting for the full convention and docs/architecture/x-extensions.md for the extension shape.

Syntax

Examples

• sort=createdAt — oldest first
• sort=-createdAt — newest first
• sort=-priority,dueDate — highest priority first, then oldest due date
• sort=name.lastName,name.firstName — alphabetical by surname, then given name

Unique identifier of the person.

Unique identifier of the person.

Unique identifier of the person.