Skip to main content
GET
Get membership settings

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

customerId
string
required

Customer ID

Minimum string length: 1
Example:

"200"

Response

Get membership settings

Customer membership access settings

customerId
integer
required

Customer ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

200

allowDomainAutoJoin
boolean
required

When true, users with a verified matching domain email join immediately as members without admin approval. Defaults to true for top-level organizations and false for child accounts; an explicit setting overrides the default. Requires customerDomain to be set.

Example:

false

customerDomain
string | null

Customer domain used to determine auto-join eligibility.

Example:

"nike.com"

domainChoices
string[]

The domains the organization has verified, for a child account or for the organization itself: the only new values the customerDomain of a child buyer or agents account can take (a seller account keeps its own brand domain). Empty for a standalone account.

Example: