Skip to content

Authentication

Authentication for Tallyfy Answers API

All API requests to Tallyfy Answers require authentication using an API key. This key validates your identity and permissions when accessing the API endpoints.

Tallyfy uses a centralized identity and access management system at account.tallyfy.com for all products. This system handles sign up, sign in, SSO, and account management functions like password recovery across all Tallyfy products.

If your account is a member of multiple organizations, you can easily switch between them. Click your name/profile picture in the top-right corner and select “Switch organization” to access other roles and organizations associated with your account.

API key header

Add the following header to all your API requests:

X-Answers-API-Key: your_api_key

Replace your_api_key with the actual API key provided to your account.

Obtaining an API key

To get an API key:

  1. Log in to your Tallyfy Answers account
  2. Navigate to the API Settings section
  3. Click Generate API Key
  4. Copy the generated key for use in your applications

API key security best practices

  • Do not share your API key in public repositories or client-side code
  • Store your API key in environment variables or secure configuration files
  • Regenerate your API key if you suspect it has been compromised
  • Use different API keys for development and production environments

Example authenticated request

Terminal window
curl -X GET https://go.tallyfy.com/api/answers/collections/my_collection \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Authentication errors

If you receive a 401 Unauthorized response, check that:

  • Your API key is valid and active
  • You’ve correctly included the X-Answers-API-Key header
  • Your account has the necessary permissions for the requested operation

Collections > Delete a collection

The DELETE endpoint permanently removes collections and their objects through a straightforward API call while offering best practices and alternatives to mitigate risks of irreversible data loss.

Objects > Get an object

The API endpoint enables fetching specific objects from collections using unique identifiers through a GET request that returns complete object data with automatic system fields.

Answers > Search

A search operation within Tallyfy Answers performs queries on collections to retrieve relevant objects and information from the system.

Collections > Get all collections

The GET /v1/collections endpoint lets users retrieve paginated summaries of collections sorted by creation date including object counts and metadata for each collection in their account.