Skip to content

Get an object

How do you retrieve individual objects from Tallyfy Answers?

This endpoint allows you to fetch a specific object from a collection using its unique identifier.

Use this endpoint to access the complete data for an individual record.

API endpoint

GET /v1/collections/{collection_name}/objects/{object_id}

Request parameters

ParameterTypeRequiredDescription
collection_namepathYesName of the collection containing the object
object_idpathYesUnique identifier of the object to retrieve

Response

A successful object retrieval request returns a 200 OK status code and a JSON object containing all the properties of the requested object:

{
"id": "product-123",
"name": "Wireless Headphones",
"description": "Premium noise-canceling headphones with 20-hour battery life",
"price": 79.99,
"categories": ["electronics", "audio", "wireless"],
"created_at": "2023-08-15T14:32:21Z",
"updated_at": "2023-08-15T14:32:21Z"
}

Error scenarios

StatusDescription
404Object or collection not found
400Invalid object ID format

Example request

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

What are important usage considerations?

  • Object retrieval is suitable for displaying detailed information about a specific item
  • For searching across multiple objects, use the search endpoint instead
  • The Tallyfy Answers API returns the complete object with all its properties
  • System fields like created_at and updated_at are automatically included1

Collections > Get a collection

The Tallyfy Answers API provides a GET endpoint to retrieve detailed information about specific collections including metadata schema information and object counts using the collection’s unique name.

Objects > Delete an object

The DELETE endpoint permanently removes specific objects from Tallyfy Answers collections using unique identifiers and returns confirmation upon successful deletion with no recovery option available.

Answers > Objects

Objects in Tallyfy Answers are fundamental JSON-formatted data records that belong to collections and can be indexed retrieved and searched using either custom or auto-generated unique identifiers while supporting flexible schema-less structure and various management operations.

Objects > Index a single object

The Tallyfy Answers API endpoint enables adding single objects to collections in real-time through POST requests with JSON data ideal for individual record creation and testing while bulk operations should use the import endpoint for better performance.

Footnotes

  1. ISO 8601 format timestamps (YYYY-MM-DDTHH:mm:ssZ) tracked at microsecond precision in PostgreSQL