Skip to main content
GET
/
customers
List 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
  }
}
​
id
string
Unique identifier of the customer
​
status
enum
Status of the account (`ACTIVE`, `ARCHIVED`)
​
id
string
​
status
string

Allowed filter combinations

  • id
  • status
Fields that can be searched on using _search query param
​
id
string
​
name
string
​
primary_email
string
Fields with which the list response can be sorted using _sort query param
​
id
string
​
updated_at
string
Default sort order:updated_at DESC, id ASC

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
nextToken
string
Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

​
pageSize
number
Example:

10

Response

Response for list customers request

​
data
object[]
​
nextToken
string
​
context
object