Get a collection

Retrieving collection details

This endpoint allows you to fetch detailed information about a specific collection in Tallyfy Answers 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://go.tallyfy.com/api/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 Tallyfy Answers API provides a GET endpoint that retrieves individual objects from collections using their unique identifier and returns complete object data with all properties including system-generated timestamps.

Collections > Create a collection

Creating collections in Tallyfy Answers requires using a POST API endpoint with a unique collection name and optional description where the system automatically detects data types as objects are indexed.

Collections > Get all collections

The GET /v1/collections endpoint retrieves all collections in your Tallyfy Answers account sorted by creation date with pagination support through limit and offset parameters returning collection summaries with metadata and object counts.

Collections > Update a collection

The PATCH endpoint enables modification of existing collection properties like descriptions in Tallyfy Answers while maintaining immutable collection names and providing structured JSON responses with error handling.