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

​
List Customers

​
search
string
Search by name, email, phone, or company
​
tier
string
Filter by customer tier: bronze, silver, gold, platinum
​
status
string
Filter by status: active, inactive, archived
​
tags
array
Filter by tags (array of strings)
​
page
integer
Page number (default: 1)
​
limit
integer
Items per page (default: 20, max: 100)
​
success
boolean
true
​
data
array
Array of customer objects
​
pagination.total
number
Total number of customers
​
pagination.page
number
Current page number
​
pagination.limit
number
Items per page
​
pagination.totalPages
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

​
id
string
required
Customer ID
​
success
boolean
true
​
data._id
string
Customer ID
​
data.profile.firstName
string
Customer first name
​
data.profile.lastName
string
Customer last name
​
data.profile.email
string
Customer email address
​
data.profile.phone
string
Customer phone number
​
data.profile.company
string
Company name
​
data.tier
string
Customer tier: bronze, silver, gold, platinum
​
data.status
string
Status: active, inactive, archived
​
data.tags
array
Array of tag strings
​
data.createdAt
string
ISO 8601 timestamp of creation
​
data.updatedAt
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

​
firstName
body
Customer first name
​
lastName
body
Customer last name
​
email
body
Customer email address
​
phone
body
Customer phone number
​
company
body
Company name
​
jobTitle
body
Job title
​
tier
body
Customer tier: bronze, silver, gold, platinum (default: standard)
​
tags
body
Array of tag strings
​
customFields
body
Custom fields object
​
success
boolean
true
​
data
object
Created customer object
At least one of firstName, lastName, email, or phone is required.

​
Update Customer

​
id
string
required
Customer ID
​
firstName
body
Update first name
​
lastName
body
Update last name
​
email
body
Update email address
​
phone
body
Update phone number
​
company
body
Update company name
​
jobTitle
body
Update job title
​
tier
body
Update customer tier
​
status
body
Update status: active, inactive, archived
​
tags
body
Update tags array
​
customFields
body
Update custom fields
​
success
boolean
true
​
data
object
Updated customer object

​
Delete Customer

​
id
string
required
Customer ID
​
success
boolean
true
​
message
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