Get a collection

Retrieving collection details

This endpoint allows you to fetch detailed information about a specific collection using its unique name. The response includes collection metadata, schema information, and object counts.

API endpoint

GET /v1/collections/{collection_name}

Path parameters

Parameter	Type	Required	Description
collection_name	string	Yes	Name of the collection to retrieve

Response

A successful request returns a 200 OK status code and a JSON response containing:

{
  "name": "products",
  "description": "Collection of product information",
  "schema": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "price": {
      "type": "number"
    },
    "categories": {
      "type": "string[]"
    }
  },
  "object_count": 142,
  "created_at": "2023-08-15T14:32:21Z",
  "updated_at": "2023-09-01T09:45:33Z"
}

Response fields

Field	Type	Description
name	string	The collection’s unique identifier
description	string	Optional description of the collection
schema	object	Auto-detected schema based on indexed objects
object_count	number	Total number of objects in the collection
created_at	string	ISO timestamp when the collection was created
updated_at	string	ISO timestamp when the collection was last modified

Error scenarios

Status	Description
404	Collection not found
400	Invalid collection name format

Example request

curl -X GET https://api.tallyfy.com/v1/collections/products \
  -H "X-Answers-API-Key: your_api_key"

Common uses

• Checking a collection’s current schema
• Verifying the number of objects in a collection
• Retrieving collection metadata before performing operations
• Confirming a collection exists before adding objects

Related articles

Objects > Get an object

The API endpoint enables retrieval of specific objects from collections through unique identifiers returning complete object data in JSON format with automatic system fields inclusion and error handling mechanisms.

Collections > Get all collections

A comprehensive API endpoint that retrieves paginated collections sorted by creation date while providing metadata and support for limit and offset parameters through GET requests to /v1/collections.

Collections > Create a collection

A guide explaining how to create collections in Tallyfy Answers through the API endpoint with required parameters naming conventions and automatic data type detection for storing objects.

Collections > Update a collection

The PATCH endpoint enables modification of collection properties like descriptions and configurations while maintaining immutable collection names and automatically handling schema changes through object indexing.