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>"
}Returns a paginated list of 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>"
}API key obtained from FlexPortal dashboard
Your tenant identifier
Items per page (default: 50, max: 100)
Cursor for pagination
Filter by status (active, inactive)
Filter by type (individual, business)
Filter by exact email match
List of customers
Show child attributes
individual, business active, inactive Show child attributes
Show child attributes