Search Inquiries
Search for inquiries using a flexible query language.
## Search vs. List Endpoints
The Search and List endpoints serve different purposes and have distinct performance characteristics.
Use the **Search** endpoint (`POST /inquiries/search`) when you need to perform complex queries with boolean logic (AND/OR/NOT), filter on multiple statuses simultaneously, or apply multiple conditions at once. Search is optimized for flexible querying and is faster than paginating through all resources when looking for specific records.
Use the **List** endpoint (`GET /inquiries`) for simple listing with basic filters like reference ID.
## Data Freshness
Do not use search for read-after-write flows because the data will not be immediately available to search.
Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification.
Propagation of new or updated data could be delayed during an outage.
For workflows that require immediate data availability after creating or updating an inquiry, use the List Inquiries endpoint instead.
### Searchable Attributes
The following attributes can be used in query predicates:
| Attribute | Description |
|-----------|-------------|
| `status` | Inquiry status (e.g., `pending`, `completed`, `approved`, `declined`) |
| `created_at` | Inquiry creation timestamp |
| `updated_at` | Inquiry last updated timestamp |
| `reference_id` | Reference ID associated with the inquiry's account |
| `inquiry_template_id` | Inquiry template ID (e.g., `itmpl_ABC123`) |
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
Key-Inflection
Determines casing for the API response.
Allowed values:
Idempotency-Key
Ensures the request is idempotent.
Persona-Version
Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).
Query parameters
fields
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.
page
Request
This endpoint expects an object.
query
Search query using boolean logic (AND/OR/NOT) and comparison operators. Supports predicates with operators: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal).
sort
Sort configuration for results
page
Pagination parameters
Response headers
RateLimit-Limit
The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.
RateLimit-Remaining
The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.
RateLimit-Reset
The number of seconds until the current rate limit window resets. Returned on every authenticated response.
Request-Id
The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.
Persona-Environment-Id
The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.
Persona-Organization-Id
The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.
Response
This endpoint returns a collection of Inquiry objects matching the search criteria.
data
An array of Inquiries matching the search criteria
links
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error