Path parameters

• email string Required

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  • id integer

    Customer id

  • group_id integer

    Group id

  • default_billing string

    Default billing address id

  • default_shipping string

    Default shipping address id

  • confirmation string

    Confirmation

  • created_at string

    Created at time

  • updated_at string

    Updated at time

  • created_in string

    Created in area

  • dob string

    In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers (e.g., full name) before collecting or processing such data.

  • email string Required

    Email address

  • firstname string Required

    First name

  • lastname string Required

    Last name

  • middlename string

    Middle name

  • prefix string

    Prefix

  • suffix string

    Suffix

  • gender integer

    Gender

  • store_id integer

    Store id

  • taxvat string

    Tax Vat

  • website_id integer

    Website id

  • addresses array[object]

    Customer address interface.

    Hide addresses attributes Show addresses attributes object

    • id integer

      ID

    • customer_id integer

      Customer ID

    • region object

      Customer address region interface.

      Hide region attributes Show region attributes object

      • region_code string Required

        Region code

      • region string Required

        Region

      • region_id integer Required

        Region id

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface

    • region_id integer

      Region ID

    • country_id string

      Country code in ISO_3166-2 format

    • street array[string]

      Street

    • company string

      Company

    • telephone string

      Telephone number

    • fax string

      Fax number

    • postcode string

      Postcode

    • city string

      City name

    • firstname string

      First name

    • lastname string

      Last name

    • middlename string

      Middle name

    • prefix string

      Prefix

    • suffix string

      Suffix

    • vat_id string

      Vat id

    • default_shipping boolean

      If this address is default shipping address.

    • default_billing boolean

      If this address is default billing address

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface

    • custom_attributes array[object]

      Interface for custom attribute value.

      Hide custom_attributes attributes Show custom_attributes attributes object

      • attribute_code string Required

        Attribute code

      • value string Required

        Attribute value

  • disable_auto_group_change integer

    Disable auto group change flag.

  • extension_attributes object

    ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface

    Hide extension_attributes attributes Show extension_attributes attributes object

    • company_attributes object

      Extended customer custom attributes interface.

      Hide company_attributes attributes Show company_attributes attributes object

      • customer_id integer

        Customer ID.

      • company_id integer

        Company ID.

      • job_title string

        Get job title.

      • status integer

        Customer status.

      • telephone string

        Get telephone.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface

    • is_subscribed boolean
    • assistance_allowed integer
  • custom_attributes array[object]

    Interface for custom attribute value.

    Hide custom_attributes attributes Show custom_attributes attributes object

    • attribute_code string Required

      Attribute code

    • value string Required

      Attribute value

• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• 500

  Internal Server error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace