Elastic Path Searchable Fields API
The Searchable Fields API returns a list of all fields available for searching, filtering, faceting, and sorting in your search queries. This includes both the standard product fields that are indexed by default and any custom fields you've added through Indexable Fields.### Using Searchable FieldsUse this endpoint to:- **Discover available fields**: See all fields that can be used in search queries- **Build dynamic UIs**: Programmatically generate filter and facet options based on available fields- **Validate configurations**: Verify that your indexable fields have been properly added to the schema### Field PropertiesEach searchable field includes:| Property | Description || --- | --- || `name` | The field name to use in search queries || `type` | The data type (`string`, `int32`, `int64`, `float`, `bool`) || `facetable` | Whether the field can be used for faceting || `sortable` | Whether the field can be used for sorting || `locale` | The language code for text fields |### Standard vs Custom Fields- **Standard fields**: Built-in fields like `name`, `description`, `sku`, `meta.search.nodes.name` that are always available- **Custom fields**: Fields added through Indexable Fields from your product extensions
Elastic Path Searchable Fields API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Searchable Fields. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.
Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Path Searchable Fields API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
The Searchable Fields API returns a list of all fields available for searching, filtering, faceting, and sorting in your search queries. This includes both the standard product fi…
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SearchableFieldAttributes (5 properties), Error (4 properties), SearchableField (4 properties), SearchableFieldsResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.