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) |
Request
- Base URL: https://api.withpersona.com/api/v1
- URL: https://api.withpersona.com/api/v1/inquiries/search
- Auth: HTTP bearer
Query parameters
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 for more details.
Headers
Determines casing for the API response.
Ensures the request is idempotent.
Server API version. More info on versioning can be found here.
Request body
Response
This endpoint returns a collection of Inquiry objects matching the search criteria.
Changes
No recorded changes to this operation across all 1 revision of this API.