Get customer collection

GET

/rest/v1/customer/customer

Parameters

Query Parameters

filter[id]

Filter by customer IDs

Type

string

filter[mail]

Filter by mail (partial)

Type

string

filter[name]

Filter by name (partial)

Type

string

filter[surname]

Filter by surname (partial)

Type

string

filter[country]

Filter by country

Type

string

filter[city]

Filter by city (partial)

Type

string

filter[hasAccess]

Filter by access status

Type

boolean

filter[isGuest]

Filter by guest status

Type

boolean

filter[isSanitized]

Filter by sanitized status

Type

boolean

filter[lang]

Filter by language

Type

string

sort

Sort order

Type

string

page

Page number

Type

integer

limit

Pagination limit

Type

integer

Responses

Successful operation

Content-Type

application/json

"string"

GET

/rest/v1/customer/customer

Playground

Variables

Key

Value

filter[id]

filter[mail]

filter[name]

filter[surname]

filter[country]

filter[city]

filter[hasAccess]

filter[isGuest]

filter[isSanitized]

filter[lang]

sort

page

limit

Samples

Powered by VitePress OpenAPI