Get customers

Required Scopes: CUSTOMER_READ

Returns all customers from studio in expected slices

SecurityApiKeyAuth

Request

query Parameters

cardNumberFormat	string (CardNumberFormat) Default: "DECIMAL" Defines how card numbers are interpreted Enum: "DECIMAL" "HEX_MSB" "HEX_LSB"
lastOffsetId	integer <int64> Deprecated Last ID of customer from last chunk
offset	string Offset from last request
sliceSize	integer <int32> [ 50 .. 500 ] Default: 100 Desired size of data chunk
customerStatus	string Default: "MEMBER" Defines status of returned customers Enum: "MEMBER" "PROSPECT"

Responses

200

400

Validation of the request failed.

401

Authentication failed. No api-key, wrong api-key or wrong header name.

403

Authorization failed. The caller has no privilege to the given resource.

404

Entity does not exists.

409

Conflict

429

Access denied - rate limit is exceeded.

500

Unexpected system error.

get/v1/customers

Request samples

curl

Response samples

application/json

{"result": [{"id": 1001,
"customerNumber": "1-12345",
"firstName": "Edgar",
"lastName": "Bullock",
"dateOfBirth": "1952-05-04",
"email": "example@email.com",
"gender": "MALE",
"street": "Am Bahnhof",
"houseNumber": 89,
"zipCode": "12133",
"city": "Munich",
"country": "DE",
"status": "MEMBER",
"cardNumbers": ["1290158199"
],
"imageUrl": "https://example.com",
"phonePrivate": "+49 30901820",
"phonePrivateMobile": "+49 15223433333",
"phoneBusiness": "+49 30901820",
"phoneBusinessMobile": "+49 15223433333",
"idlePeriods": [{"id": 1000,
"startDate": "2022-01-01",
"endDate": "2022-10-01",
"reason": "Illness",
"contract": {"id": 1000,
"rateName": "Premium"
}
}
],
"bankAccount": {"accountHolder": "Sven Hannawald",
"bankName": "Deutsche Bank",
"bic": "DEUTDEFFXXX",
"iban": "DE91 1000 0000 0123 4567 89"
},
"accessRefusal": true,
"uuid": "7be3932c-825b-4401-abff-29e9f9410bc7",
"referralCode": "20J6N",
"studioId": 1238735970,
"preferredLanguage": {"languageCode": "de",
"countryCode": "DE"
}
}
],
"hasNext": true,
"offset": "100",
"lastOffsetId": 100
}