Skip to main content
GET
/
v1
/
customers
/
{customerId}
Get a customer
curl --request GET \
  --url https://api-eu.flexportal.io/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-ID: <tenant-id>'
{
  "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>"
}

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

customerId
string
required

The customer ID

Response

Customer details

customerId
string
required
tenantId
string
required
email
string
required
firstName
string
required
lastName
string
required
customerType
enum<string>
required
Available options:
individual,
business
totalOrders
number
required
totalDevicesRented
number
required
totalMonthlyRevenue
number
required
status
enum<string>
required
Available options:
active,
inactive
orderIds
string[]
required
rentalIds
string[]
required
createdBy
string
required
company
string
phone
string
customFields
object
lastBillingAddress
object
lastShippingAddress
object
createdAt
any
updatedAt
any