API Documentation

API Documentation
Overview Authentication Rate Limits Error Handling API Endpoints Users API - Get User Details Check-ins API Products API Services API Webhooks SDKs & Libraries
Resources
API Best Practices Webhooks Setup Guide Code Examples API Reference User Guides User Import/Export

Tagify Business API Documentation

Welcome to the Tagify Business API documentation. Our API enables seamless integration with your business systems.

Note: This API is available to Business tier subscribers only. Upgrade your account to access these features.

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Rate Limits

To ensure service stability, API requests are subject to rate limiting:

Plan Rate Limit
Business 100 requests per minute
Enterprise 500 requests per minute

API Endpoints

All API endpoints are prefixed with /api/v1.

Users API

Need to import or export users? Check our User Import/Export Guide.
GET /api/v1/users
List Users

Retrieve a list of users for your business.

Query Parameters
Parameter Type Description
page integer Page number (default: 1)
limit integer Results per page (default: 20, max: 100)
status string Filter by status (active, inactive, pending)
GET /api/v1/users/{user_id}
Get User Details

Retrieve detailed information about a specific user.

Path Parameters
Parameter Type Description
user_id string The unique identifier of the user
Response Example
{
  "id": "usr_12345",
  "email": "[email protected]",
  "first_name": "John",
  "last_name": "Doe",
  "card_id": "card001",
  "dob": "1990-05-15",
  "status": "active",
  "points_balance": 150,
  "is_paying": true,
  "created_at": "2023-01-15T08:30:00Z",
  "updated_at": "2023-06-22T14:45:00Z",
  "last_login": "2023-06-22T14:45:00Z",
  "membership_level": "gold",
  "tags": ["loyal", "frequent"]
}

User Import/Export Guide

Overview

This guide explains how to import and export users using CSV files in Tagify. The system provides flexible options for handling user data, including automatic or manual card ID assignment.

Table of Contents

CSV Format

Required Fields
  • email - User's email address
  • first_name - User's first name
  • last_name - User's last name
Optional Fields
  • card_id - Unique card identifier (auto-generated if not provided)
  • dob - Date of birth (format: YYYY-MM-DD)
  • status - User status (default: 'active')
  • points_balance - Initial points balance (default: 0)
  • is_paying - Whether the user is a paying member (0 or 1)
  • payment_amount - Monthly subscription amount (required if is_paying=1)
  • payment_method - User's preferred payment method
Payment Information
Payment Amount Rules:
  • Required when is_paying=1
  • Must be between $9.99 and $999.99
  • Must be a valid number with up to 2 decimal places
  • Must be in USD currency
Supported Payment Methods:
  • Credit Card
  • Debit Card
  • Cash
  • Bank Transfer
  • Check
  • Other
Example CSV Format
email,first_name,last_name,card_id,dob,status,points_balance,is_paying,payment_amount,payment_method
[email protected],John,Doe,10000001,1990-05-15,active,150,1,29.99,Credit Card
[email protected],Jane,Doe,10000002,1985-06-20,active,200,1,19.99,Debit Card

Importing Users

Step-by-Step Import Process
  1. Navigate to Dashboard > Users > Import/Export
  2. Click "Import Users"
  3. Choose your CSV file
  4. Select Import Options:
    • Auto-generate Card IDs: System will create unique IDs
    • Use Existing Card IDs: Use IDs from CSV file
  5. Review the preview of data
  6. Confirm import
Import Options
Auto-generate Card IDs
  • System generates unique IDs following your business prefix
  • Ensures no duplicate IDs
  • Recommended for new user imports
Use Existing Card IDs
  • Uses card IDs from your CSV file
  • Validates for duplicates
  • Useful when migrating from another system
Validation Rules
  • Email addresses must be unique
  • Card IDs must be unique (if provided)
  • Required fields cannot be empty
  • Date formats must be YYYY-MM-DD
  • Points balance must be numeric
  • is_paying must be 0 or 1 (boolean)

Exporting Users

Export Options
Full Export
  • Exports all user data including payment status
  • Includes all fields and historical data
Basic Export
  • Essential fields only
  • Suitable for template creation
Custom Export
  • Select specific fields
  • Filter users by status, payment status, date range, etc.

Troubleshooting

  1. Duplicate Emails
    • Each email must be unique
    • System will flag duplicates during validation
  2. Invalid Card IDs
    • Must match your business format
    • Cannot contain special characters
  3. Date Format Issues
    • Use YYYY-MM-DD format
    • Example: 1990-05-15
Need Help?
  • Contact support at [email protected]
  • Visit our help center at help.tagify.tech
  • Check our community forum for common solutions
Updates and Changes
  • Version 1.1 (2024-02-23)
    • Added is_paying field for payment status tracking
    • Updated import/export functionality to handle payment status
    • Enhanced validation for payment status field
  • Version 1.0 (2024-02-10)
    • Initial documentation release
    • Basic import/export functionality
    • Auto-generation of card IDs

Last updated: February 23, 2024