Skip to main content
GET
List customer attributes

Authorizations

X-Api-Key
string
header
required

API key for your store

Query Parameters

page
integer
default:1

Page number, from 1.

Required range: x >= 1
limit
integer
default:25

Number of results per page.

Required range: 1 <= x <= 100
is_readonly
boolean

false: only the attributes shoppers can set; true: only the others.

kind
enum<string>

Only attributes of this kind. linked: the ones POST /auth/forgot-username takes. Who sets the attribute's values. custom: the store's own attribute, set by admins and, unless it is is_readonly, by shoppers. linked: set from the customer's KYC document of the same type: the document number once it is approved, otherwise not_submitted, submitted or rejected. system: set by Commerce Engine, such as the campaign source of a shopper's first and latest visits (initial-utm-source, utm-source).

Available options:
custom,
linked,
system

Response

OK

message
string
required
Example:

"Attributes retrieved successfully."

success
boolean
required
content
object
required