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 through the /v1/collections/[collection_name] path.

Collections > Create a collection

The process of creating collections in Tallyfy Answers involves specifying a unique name through a POST request which automatically detects data types and returns collection details upon successful creation.

Collections > Get all collections

A paginated API endpoint that retrieves summaries of all collections sorted by creation date with support for limiting results and skipping records for efficient data browsing.

Objects > Delete an object

The DELETE endpoint permanently removes objects from collections using unique identifiers while offering alternatives like soft deletion and archiving for data preservation.