Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

Path Parameters

index_uid
string
required

Unique identifier of the index whose fields to list.

Body

application/json
offset
integer

Number of fields to skip. Defaults to 0.

Required range: x >= 0
limit
integer

Maximum number of fields to return. Defaults to 20.

Required range: x >= 0
filter
null | object

Optional filter to restrict which fields are returned (e.g. by attribute patterns or by capability: displayed, searchable, sortable, filterable, etc.).

Response

results
object[]
required

Items for the current page.

offset
integer
required

Number of items skipped.

Required range: x >= 0
limit
integer
required

Maximum number of items returned.

Required range: x >= 0
total
integer
required

Total number of items matching the query.

Required range: x >= 0