Skip to main content
GET
/
collections
/
{collectionId}
cURL
curl --request GET \
  --url https://api.sparq.ai/v2/collections/{collectionId} \
  --header 'Authorization: Bearer <token>'
[
  {
    "searchFields": "<unknown>",
    "groupByFields": "<unknown>",
    "sortDirection": "<unknown>",
    "stopWordEnabled": "<unknown>",
    "stemmingEnabled": "<unknown>",
    "pluralsEnabled": "<unknown>",
    "typoTolerance": "<unknown>",
    "minCharsTypoTolerance": "<unknown>",
    "textFacetFields": "<unknown>",
    "numericFacetFields": "<unknown>",
    "maxFacetCount": "<unknown>",
    "pageSize": "<unknown>",
    "maxFetchCount": "<unknown>",
    "whitelistedFields": "<unknown>",
    "createdAt": "<unknown>",
    "updatedAt": "<unknown>",
    "title": "<unknown>",
    "indexFields": "<unknown>",
    "sortField": "<unknown>",
    "uniqueId": "<unknown>",
    "indexStatus": "<unknown>",
    "isDeletionProcessed": "<unknown>",
    "delimitersSetting": "<unknown>",
    "appUniqueId": "<unknown>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
collectionId
string
required

Unique identifier for the collection.

Response

Successful response containing details of the collection.

​
searchFields
any

An array specifying fields considered for text search queries. If empty, all text fields may be searched.

​
groupByFields
any

An array defining fields for grouping results. Empty means no grouping is applied.

​
sortDirection
any

Fields on which the search is indexed.

​
stopWordEnabled
any

A boolean indicating whether stop words are filtered out from search queries to improve relevancy.

​
stemmingEnabled
any

A boolean specifying if stemming is applied to search queries to find root forms of words.

​
pluralsEnabled
any

A boolean indicating whether plural and singular forms of words are considered equivalent in search queries.

​
typoTolerance
any

An integer specifying the level of typo tolerance in search queries, with higher numbers allowing more typos.

​
minCharsTypoTolerance
any

An integer indicating the minimum number of characters a word must have to be subject to typo tolerance.

​
textFacetFields
any

An array of fields for which textual facets are enabled.

​
numericFacetFields
any

An array of fields for which numeric facets are available.

​
maxFacetCount
any

An integer specifying the maximum number of facets to return for faceted search queries.

​
pageSize
any

An integer indicating the number of search results to display per page.

​
maxFetchCount
any

An integer defining the maximum number of items that can be fetched in a single query.

​
whitelistedFields
any

An array specifying fields allowed to be included in the response. If empty, all fields are considered.

​
createdAt
any

A timestamp indicating when the configuration was created.

​
updatedAt
any

A timestamp showing the last update time of the configuration.

​
title
any

A string representing the title or name of the index or dataset.

​
indexFields
any

Reserved for specifying which fields are indexed.

​
sortField
any

A string specifying the default field to sort by.

​
uniqueId
any

A string providing a unique identifier for the configuration or index.

​
indexStatus
any

An integer indicating the status of the index.

​
isDeletionProcessed
any

A boolean indicating whether deletion of the index or data has been processed.

​
delimitersSetting
any

An array for specifying custom delimiters in text processing.

​
appUniqueId
any

A string providing a unique identifier for the application or project associated with this configuration.