Get a collection

Retrieving collection details

Section titled “Retrieving collection details”

This endpoint lets you fetch information about a specific collection in Tallyfy Answers using its unique name. You’ll get collection metadata, schema information, and object counts in the response.

API endpoint

Section titled “API endpoint”

GET /v1/collections/{collection_name}

Path parameters

Section titled “Path parameters”

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

Response

Section titled “Response”

On success, you’ll receive 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

Section titled “Response fields”

Field	Type	Description
name	string	The collection’s unique identifier
description	string	Optional description of the collection
schema	object	Schema that’s auto-detected based on indexed objects1
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

Section titled “Error scenarios”

Status	Description
404	Collection not found
400	Invalid collection name format

Example request

Section titled “Example request”

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

Common uses

Section titled “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

Section titled “Related articles”

Objects > Get an object

Retrieve a specific object from a Tallyfy Answers collection using its unique identifier…

Collections > Create a collection

Create collections in Tallyfy Answers using a POST request to the /v1/collections endpoint. Each…

Collections > Get all collections

The GET /v1/collections endpoint retrieves all collections in your Tallyfy Answers account…

Answers > Collections

Collections in Tallyfy Answers group similar objects together, like database tables. They…

Footnotes

Section titled “Footnotes”

1. Schema types are inferred from first 100 objects; explicit schemas can override auto-detection ↩

Was this helpful?

YesNo