MageSmith
magento/module-customer · Magento 2.4.9

Customer REST endpoints

vendor/magento/module-customer/etc/webapi.xml

42 endpoints

GET

GET

/V1/attributeMetadata/customer

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAllAttributesMetadata

→
GET

/V1/attributeMetadata/customer/attribute/:attributeCode

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAttributeMetadata

→
GET

/V1/attributeMetadata/customer/custom

Customer · Magento\Customer\Api\CustomerMetadataInterface::getCustomAttributesMetadata

→
GET

/V1/attributeMetadata/customer/form/:formCode

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAttributes

→
GET

/V1/attributeMetadata/customerAddress

Customer · Magento\Customer\Api\AddressMetadataInterface::getAllAttributesMetadata

→
GET

/V1/attributeMetadata/customerAddress/attribute/:attributeCode

Customer · Magento\Customer\Api\AddressMetadataInterface::getAttributeMetadata

→
GET

/V1/attributeMetadata/customerAddress/custom

Customer · Magento\Customer\Api\AddressMetadataInterface::getCustomAttributesMetadata

→
GET

/V1/attributeMetadata/customerAddress/form/:formCode

Customer · Magento\Customer\Api\AddressMetadataInterface::getAttributes

→
GET

/V1/customerGroups/:id

Get customer group by group ID.

Customer · Magento\Customer\Api\GroupRepositoryInterface::getById

→
GET

/V1/customerGroups/:id/permissions

Check if customer group can be deleted.

Customer · Magento\Customer\Api\GroupManagementInterface::isReadonly

→
GET

/V1/customerGroups/default

Get default customer group.

Customer · Magento\Customer\Api\GroupManagementInterface::getDefaultGroup

→
GET

/V1/customerGroups/default/:storeId

Get default customer group.

Customer · Magento\Customer\Api\GroupManagementInterface::getDefaultGroup

→
GET

/V1/customerGroups/search

Retrieve customer groups.

Customer · Magento\Customer\Api\GroupRepositoryInterface::getList

→
GET

/V1/customers/:customerId

Get customer by Customer ID.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::getById

→
GET

/V1/customers/:customerId/billingAddress

Retrieve default billing address for the given customerId.

Customer · Magento\Customer\Api\AccountManagementInterface::getDefaultBillingAddress

→
GET

/V1/customers/:customerId/confirm

Gets the account confirmation status.

Customer · Magento\Customer\Api\AccountManagementInterface::getConfirmationStatus

→
GET

/V1/customers/:customerId/password/resetLinkToken/:resetPasswordLinkToken

Anonymous

Check if password reset token is valid.

Customer · Magento\Customer\Api\AccountManagementInterface::validateResetPasswordLinkToken

→
GET

/V1/customers/:customerId/permissions/readonly

Check if customer can be deleted.

Customer · Magento\Customer\Api\AccountManagementInterface::isReadonly

→
GET

/V1/customers/:customerId/shippingAddress

Retrieve default shipping address for the given customerId.

Customer · Magento\Customer\Api\AccountManagementInterface::getDefaultShippingAddress

→
GET

/V1/customers/addresses/:addressId

Retrieve customer address.

Customer · Magento\Customer\Api\AddressRepositoryInterface::getById

→
GET

/V1/customers/me

Self

Get customer by Customer ID.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::getById

→
GET

/V1/customers/me/billingAddress

Self

Retrieve default billing address for the given customerId.

Customer · Magento\Customer\Api\AccountManagementInterface::getDefaultBillingAddress

→
GET

/V1/customers/me/shippingAddress

Self

Retrieve default shipping address for the given customerId.

Customer · Magento\Customer\Api\AccountManagementInterface::getDefaultShippingAddress

→
GET

/V1/customers/search

Retrieve customers which match a specified criteria.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::getList

→

POST

POST

/V1/customerGroups

Save customer group.

Customer · Magento\Customer\Api\GroupRepositoryInterface::save

→
POST

/V1/customers

Anonymous

Create customer account. Perform necessary business operations like sending email.

Customer · Magento\Customer\Api\AccountManagementInterface::createAccount

→
POST

/V1/customers/activate

Anonymous

Activate a customer account using a key that was sent in a confirmation email.

Customer · Magento\Customer\Api\AccountManagementInterface::activate

→
POST

/V1/customers/confirm

Resend confirmation email.

Customer · Magento\Customer\Api\AccountManagementInterface::resendConfirmation

→
POST

/V1/customers/isEmailAvailable

Anonymous

Check if given email is associated with a customer account in given website.

Customer · Magento\Customer\Api\AccountManagementInterface::isEmailAvailable

→
POST

/V1/customers/resetPassword

Anonymous

Reset customer password.

Customer · Magento\Customer\Api\AccountManagementInterface::resetPassword

→

PUT

PUT

/V1/customerGroups/:id

Save customer group.

Customer · Magento\Customer\Api\GroupRepositoryInterface::save

→
PUT

/V1/customerGroups/default/:id

Set system default customer group.

Customer · Magento\Customer\Api\CustomerGroupConfigInterface::setDefaultCustomerGroup

→
PUT

/V1/customers/:customerId

Create or update a customer.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::save

→
PUT

/V1/customers/:email/activate

Activate a customer account using a key that was sent in a confirmation email.

Customer · Magento\Customer\Api\AccountManagementInterface::activate

→
PUT

/V1/customers/me

Self

Create or update a customer.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::save

→
PUT

/V1/customers/me/activate

Self

Activate a customer account using a key that was sent in a confirmation email.

Customer · Magento\Customer\Api\AccountManagementInterface::activateById

→
PUT

/V1/customers/me/password

Self

Change customer password.

Customer · Magento\Customer\Api\AccountManagementInterface::changePasswordById

→
PUT

/V1/customers/password

Anonymous

Send an email to the customer with a password reset link.

Customer · Magento\Customer\Api\AccountManagementInterface::initiatePasswordReset

→
PUT

/V1/customers/validate

Validate customer data.

Customer · Magento\Customer\Api\AccountManagementInterface::validate

→

DELETE

DELETE

/V1/addresses/:addressId

Delete customer address by ID.

Customer · Magento\Customer\Api\AddressRepositoryInterface::deleteById

→
DELETE

/V1/customerGroups/:id

Delete customer group by ID.

Customer · Magento\Customer\Api\GroupRepositoryInterface::deleteById

→
DELETE

/V1/customers/:customerId

Delete customer by Customer ID.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::deleteById

→

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →