Customers - G-Tateth API Documentation

Manage customer profiles in your CRM. Customers represent individuals or companies that interact with your business.

List Customers

string

Search by name, email, phone, or company

string

Filter by customer tier: bronze, silver, gold, platinum

string

Filter by status: active, inactive, archived

array

Filter by tags (array of strings)

integer

Page number (default: 1)

integer

Items per page (default: 20, max: 100)

boolean

true

array

Array of customer objects

number

Total number of customers

number

Current page number

number

Items per page

number

Total number of pages

Example Request

curl -X GET "https://api.g-tateth.com/api/v1/customers?search=john&tier=gold&page=1&limit=20" \
  -H "Authorization: Bearer sk_live_your_api_key"

Example Response

{
  "success": true,
  "data": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "profile": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@example.com",
        "phone": "+1234567890",
        "company": "Acme Corp"
      },
      "tier": "gold",
      "status": "active",
      "tags": ["vip", "enterprise"],
      "createdAt": "2024-01-01T12:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 20,
    "totalPages": 8
  }
}

Get Customer

string

required

Customer ID

boolean

true

string

Customer ID

string

Customer first name

string

Customer last name

string

Customer email address

string

Customer phone number

string

Company name

string

Customer tier: bronze, silver, gold, platinum

string

Status: active, inactive, archived

array

Array of tag strings

string

ISO 8601 timestamp of creation

string

ISO 8601 timestamp of last update

Example Request

curl -X GET "https://api.g-tateth.com/api/v1/customers/507f1f77bcf86cd799439011" \
  -H "Authorization: Bearer sk_live_your_api_key"

Example Response

{
  "success": true,
  "data": {
    "_id": "507f1f77bcf86cd799439011",
    "tenantId": "507f191e810c19729de860ea",
    "profile": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com",
      "phone": "+1234567890",
      "company": "Acme Corp"
    },
    "tier": "gold",
    "status": "active",
    "tags": ["vip", "enterprise"],
    "createdAt": "2024-01-01T12:00:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Create Customer

body

Customer first name

body

Customer last name

body

Customer email address

body

Customer phone number

body

Company name

body

Job title

body

Customer tier: bronze, silver, gold, platinum (default: standard)

body

Array of tag strings

body

Custom fields object

boolean

true

object

Created customer object

At least one of firstName, lastName, email, or phone is required.

Update Customer

string

required

Customer ID

body

Update first name

body

Update last name

body

Update email address

body

Update phone number

body

Update company name

body

Update job title

body

Update customer tier

body

Update status: active, inactive, archived

body

Update tags array

body

Update custom fields

boolean

true

object

Updated customer object

Delete Customer

string

required

Customer ID

boolean

true

string

Success message

This action cannot be undone! Deleting a customer will permanently remove them and their data.

Required Permissions

read:customers - Required for GET requests
write:customers - Required for POST, PUT, DELETE requests

​List Customers

​Example Request

​Example Response

​Get Customer

​Example Request

​Example Response

​Create Customer

​Update Customer

​Delete Customer

​Required Permissions

List Customers

Example Request

Example Response

Get Customer

Example Request

Example Response

Create Customer

Update Customer

Delete Customer

Required Permissions