Skip to main content
GET
/
v1
/
customers
List customers
curl --request GET \
  --url https://api-eu.flexportal.io/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-ID: <tenant-id>'
{
  "customers": [
    {
      "customerId": "<string>",
      "tenantId": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "customerType": "individual",
      "totalOrders": 123,
      "totalDevicesRented": 123,
      "totalMonthlyRevenue": 123,
      "status": "active",
      "orderIds": [
        "<string>"
      ],
      "rentalIds": [
        "<string>"
      ],
      "createdBy": "<string>",
      "company": "<string>",
      "phone": "<string>",
      "customFields": {},
      "lastBillingAddress": {
        "contactName": "<string>",
        "streetAddress": "<string>",
        "city": "<string>",
        "country": "<string>",
        "company": "<string>",
        "buildingInfo": "<string>",
        "locality": "<string>",
        "adminArea": "<string>",
        "postalCode": "<string>"
      },
      "lastShippingAddress": {
        "contactName": "<string>",
        "streetAddress": "<string>",
        "city": "<string>",
        "country": "<string>",
        "company": "<string>",
        "buildingInfo": "<string>",
        "locality": "<string>",
        "adminArea": "<string>",
        "postalCode": "<string>"
      },
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>"
    }
  ],
  "count": 123,
  "limit": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

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