Customers
List customers
Introduction
APIs
- Authentication
- Customers
- Accounts
- Aliases
- Event Schemas
- Usage Meters
- AddOns
- Licenses
- Feature
- (Deprecated) Price Plans
- Price Plan V2
- Settings
- Price Experimentation
- Jobs
- Event Ingestion
- Entitlements
- Event Management
- Metrics
- Credits
- Invoices
- Payments
- Wallet
- InvoiceGroups
- Alerts
- Reports
Customers
List customers
Returns a list of customers with pagination and sort.
GET
/
customers
curl --request GET \
--url https://api.togai.com/customers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
"togaiCustomerId": "customer.dsvvre314.dcs314",
"name": "ACME Enterprise",
"primaryEmail": "admin@example.com",
"address": {
"phoneNumber": "+919876543210",
"line1": "2281 Broadway Street",
"line2": "G-31",
"postalCode": "29501",
"city": "Florence",
"state": "South Carolina",
"country": "US"
},
"billingAddress": "2281 Broadway Street, G-31, 29501, Florence, South Carolina, US",
"status": "ACTIVE",
"createdAt": "2020-01-01T10:10:22Z",
"updatedAt": "2020-01-01T10:10:22Z"
}
],
"nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
"context": {
"pageSize": 10
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200
application/json
Response for list customers request
Identifier of customer
Maximum length:
50Unique identifier of customer
Name of the Customer
Required string length:
3 - 255Primary email of the customer
Maximum length:
320billing address of the customer
Maximum length:
1000billing address of the customer
Contact number
Address line 1 (eg. Street, PO Box, Company Name)
Address line 2 (eg. apartment, suite, unit or building)
ZIP or postal code
City, district, suburb, town or village
State, county, province or region
Two letter country code ISO-3166-1 Alpha-2
Status of the customer
Available options:
ACTIVE, ARCHIVED curl --request GET \
--url https://api.togai.com/customers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
"togaiCustomerId": "customer.dsvvre314.dcs314",
"name": "ACME Enterprise",
"primaryEmail": "admin@example.com",
"address": {
"phoneNumber": "+919876543210",
"line1": "2281 Broadway Street",
"line2": "G-31",
"postalCode": "29501",
"city": "Florence",
"state": "South Carolina",
"country": "US"
},
"billingAddress": "2281 Broadway Street, G-31, 29501, Florence, South Carolina, US",
"status": "ACTIVE",
"createdAt": "2020-01-01T10:10:22Z",
"updatedAt": "2020-01-01T10:10:22Z"
}
],
"nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
"context": {
"pageSize": 10
}
}