Search Elements

post

https://api.layer.team/projects/{projectId}/elements/search

Search the elements in a single category. Supply categoryId (required) plus an optional filterConfig (the same shape used to create a view) and/or a free-text query (matched against element name and indexed field values, as in the in-app search). When both are provided an element must match the filters and the text query. Results are returned in the same shape as Get Elements.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

projectId

string

required

Project ID

Body Params

categoryId

string

required

Category to search within. Required.

continueFrom

string

Opaque pagination cursor returned as nextContinueFrom in a previous response. Pass this value to retrieve the next page of results. Only valid when limit is also provided.

filterConfig

object

format

string

enum

Defaults to full

Return full element field value objects (default) or the display-oriented simple format. Prefer full when a caller may need field IDs or structured payloads such as related IDs, select option metadata, quantities, file details, or formula detail.

Allowed:

limit

integer

1 to 1000

Maximum number of elements to return per page (1–1000). Recommended default: 100. When the response includes nextContinueFrom, pass it as continueFrom in the next call to retrieve the next page.

query

string

Free-text search matched against element name and indexed field values, mirroring the in-app search. When supplied, results are ranked primarily by relevance; any sort you pass only breaks ties between equally-relevant results.

sort

array of objects

Sort configuration applied to the results. When a query is supplied, relevance ranking takes precedence over this sort.

sort

Headers

x-layer-response-mode

string

enum

Optional response mode override for large payloads. Allowed values are buffered and streaming. When omitted, endpoints may choose buffered by default and fall back to streaming for oversized payloads.

Allowed:

Responses

200List of Layer Elements in a Category

413Response payload exceeded the configured size limit for this API.

4XXDefault error response.