Search customers

Required Scopes: CUSTOMER_READ

Returns all customers from all studios with activated partner integration by given criteria

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
firstName
string

Substring of customer first name starts from beginning

lastName
string

Substring of customer last name starts from beginning

email
string

Customer email

dateOfBirth
string <date>

Customer date of birth

cardNumberFormat
string (CardNumberFormat)
Default: "DECIMAL"

Defines how card numbers are interpreted

Enum: "DECIMAL" "HEX_MSB" "HEX_LSB"
Responses
200

OK

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.

post/v1/cross-studio/customers/search
Request samples
application/json
{
  • "firstName": "Edga",
  • "lastName": "Bull",
  • "email": "example@email.com",
  • "dateOfBirth": "1952-05-04",
  • "cardNumberFormat": "DECIMAL"
}
Response samples
application/json
[
  • {
    }
]