Skip to main content
GET
List customers

Overview

Retrieve a paginated list of customers with optional filtering and sorting. Customers are automatically created when orders are placed—you don’t need to create them separately.

Customer Creation

Customers are created automatically when:
  1. An order is placed with a new email address
  2. The system creates a customer record linked to that email
Subsequent orders with the same email are linked to the existing customer.

Common Use Cases

Customer Directory

Build customer management interfaces for your support or sales teams

CRM Integration

Sync customer data to external CRM systems like Salesforce or HubSpot

Reporting

Generate customer reports, segment customers, or analyze customer base

Support Lookup

Find customers by email or name to assist with support inquiries

Filtering Customers

Sorting Options

Response Fields

Key fields in each customer object:

Example: Find High-Value Customers

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Query Parameters

limit
string

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

startAfter
string

Cursor for pagination

status
string

Filter by status (active, inactive)

customerType
string

Filter by type (individual, business)

email
string

Filter by exact email match

Response

200 - application/json

List of customers

customers
object[]
required
count
number
required
limit
number
required
hasMore
boolean
required
nextCursor
string | null
required