Skip to main content
GET
/
api
/
v1
/
customers
List all customers for your tenant
curl --request GET \
  --url https://api.g-tateth.com/api/v1/customers \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "data": [
    {
      "_id": "64a1b2c3d4e5f6789012345b",
      "profile": {
        "firstName": "Jane",
        "lastName": "Smith",
        "email": "jane.smith@example.com",
        "phone": "+2348012345678",
        "company": "Acme Corp",
        "jobTitle": "Head of Operations"
      },
      "tier": "gold",
      "status": "active",
      "tags": [
        "vip",
        "enterprise"
      ],
      "customFields": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer sk_live_... (production) or Bearer sk_test_... (staging). Obtain keys from Settings → Developer Console.

Query Parameters

Search by name, email, phone, or company

tier
enum<string>

Filter by customer tier

Available options:
bronze,
silver,
gold,
platinum
status
enum<string>

Filter by status

Available options:
active,
inactive,
archived
tags
string[]

Filter by tags

page
integer
default:1

Page number

limit
integer
default:20

Items per page

Required range: x <= 100

Response

200 - application/json

List of customers

success
boolean
data
object[]
pagination
object