> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sparq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Collection Details

> Retrieve details of a specific collection.



## OpenAPI

````yaml GET /collections/{collectionId}
openapi: 3.0.1
info:
  title: OpenAPI Sparq API
  description: >-
    This API provides access to Sparq, a sample store used to demonstrate
    features of the OpenAPI specification.
  license:
    name: MIT License
  version: 1.0.0
servers:
  - url: https://api.sparq.ai/v2
security:
  - bearerAuth: []
paths:
  /collections/{collectionId}:
    get:
      description: Retrieve details of a specific collection.
      parameters:
        - name: collectionId
          in: path
          description: Unique identifier for the collection.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response containing details of the collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CollectionResponse'
        '401':
          description: Unauthorized. Authentication is required to access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CollectionResponse:
      type: object
      properties:
        searchFields:
          description: >-
            An array specifying fields considered for text search queries. If
            empty, all text fields may be searched.
        groupByFields:
          description: >-
            An array defining fields for grouping results. Empty means no
            grouping is applied.
        sortDirection:
          description: Fields on which the search is indexed.
        stopWordEnabled:
          description: >-
            A boolean indicating whether stop words are filtered out from search
            queries to improve relevancy.
        stemmingEnabled:
          description: >-
            A boolean specifying if stemming is applied to search queries to
            find root forms of words.
        pluralsEnabled:
          description: >-
            A boolean indicating whether plural and singular forms of words are
            considered equivalent in search queries.
        typoTolerance:
          description: >-
            An integer specifying the level of typo tolerance in search queries,
            with higher numbers allowing more typos.
        minCharsTypoTolerance:
          description: >-
            An integer indicating the minimum number of characters a word must
            have to be subject to typo tolerance.
        textFacetFields:
          description: An array of fields for which textual facets are enabled.
        numericFacetFields:
          description: An array of fields for which numeric facets are available.
        maxFacetCount:
          description: >-
            An integer specifying the maximum number of facets to return for
            faceted search queries.
        pageSize:
          description: >-
            An integer indicating the number of search results to display per
            page.
        maxFetchCount:
          description: >-
            An integer defining the maximum number of items that can be fetched
            in a single query.
        whitelistedFields:
          description: >-
            An array specifying fields allowed to be included in the response.
            If empty, all fields are considered.
        createdAt:
          description: A timestamp indicating when the configuration was created.
        updatedAt:
          description: A timestamp showing the last update time of the configuration.
        title:
          description: A string representing the title or name of the index or dataset.
        indexFields:
          description: Reserved for specifying which fields are indexed.
        sortField:
          description: A string specifying the default field to sort by.
        uniqueId:
          description: >-
            A string providing a unique identifier for the configuration or
            index.
        indexStatus:
          description: An integer indicating the status of the index.
        isDeletionProcessed:
          description: >-
            A boolean indicating whether deletion of the index or data has been
            processed.
        delimitersSetting:
          description: An array for specifying custom delimiters in text processing.
        appUniqueId:
          description: >-
            A string providing a unique identifier for the application or
            project associated with this configuration.
    Error:
      type: object
      properties:
        status:
          type: integer
          description: Status code indicating the error.
        data:
          type: string
          description: Additional information about the error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````