Skip to content

Get an object

Retrieving individual objects

This endpoint allows you to fetch a specific object from a collection using its unique identifier. Use this 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 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/v1/collections/products/objects/product-123 \
-H "X-Answers-API-Key: your_api_key"

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 API returns the complete object with all its properties
  • System fields like created_at and updated_at are automatically included

Collections > Get a collection

The GET endpoint retrieves detailed collection information including metadata schema and object counts by using a unique collection name while returning a JSON response with appropriate status codes and error handling.

Objects > Delete an object

A DELETE endpoint permanently removes individual objects from collections through HTTP requests and returns status codes while emphasizing the irreversible nature of deletion operations.

Answers > Objects

Objects in Tallyfy Answers serve as JSON-formatted data records with unique identifiers that can be flexibly structured indexed and searched within collections while supporting both custom and auto-generated IDs for efficient data management.

Objects > Index a single object

A POST API endpoint that enables adding individual objects to collections with JSON formatting while handling errors and providing status responses through Tallyfy Answers platform.