Customers

Get all customers

Requires admin privileges

GET/api/customers

Query parameters

Response

200400

OK

Body

application/json

advancedCustomerAdvanced (object)

categoryCustomerCategory (enum)

nonecontactprospectapplicantguestmember

addressAddressEntity (object)

usernamenullable string

gendernullable string

websitenullable string

socialSocial (object)

member_sincenullable string

house_account_enabledboolean

statusnullable string

typenullable string

customer_referencenullable string

latitudenullable string

longitudenullable string

sourcenullable string

modified_byinteger (int64)

attributesnullable array of CustomerAttribute (object)

modified_onnullable string

metaCustomerMeta (object)

global_networksnullable array of GlobalNetworkCompany (object)

idinteger (int64)

company_namenullable string

company_titlenullable string

first_namenullable string

middle_namenullable string

last_namenullable string

full_namenullable string

localenullable string

is_memberboolean

was_memberboolean

has_appliedboolean

flagCustomerFlag (enum)

changepwpendingVerificationmembership_failed_payment

emailnullable string (email)

mobilePhone (object)

phonePhone (object)

profile_photonullable string

vipboolean

home_house_idnullable string

birthdatenullable string

anniversary_datenullable string

created_onstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "advanced": {
      "opt_in_email": "text",
      "opt_in_sms": "text",
      "opt_in_updates": "text",
      "house_account_enabled": "text"
    },
    "category": "none",
    "address": {
      "address": "text",
      "address2": "text",
      "address3": "text",
      "city": "text",
      "state": "text",
      "zip_code": "text",
      "country": "text"
    },
    "username": "text",
    "gender": "text",
    "website": "text",
    "social": {
      "facebook": "text",
      "twitter": "text",
      "google": "text",
      "instagram": "text",
      "foursquare": "text",
      "linkedin": "text",
      "tiktok": "text"
    },
    "member_since": "text",
    "house_account_enabled": false,
    "status": "text",
    "type": "text",
    "customer_reference": "text",
    "latitude": "text",
    "longitude": "text",
    "source": "text",
    "attributes": [
      {
        "name": "text",
        "values": [
          "text"
        ]
      }
    ],
    "modified_on": "text",
    "meta": {
      "total_touchpoints": "text",
      "last_viewed": "text",
      "last_newsletter": "text",
      "last_touchpoint": "text",
      "last_communication": "text",
      "last_contacted": "text",
      "last_pageview": "text",
      "last_email_opened": "text",
      "last_login": "text",
      "last_viewed_by": "text",
      "app_installed": "text",
      "app_installed_on": "text"
    },
    "global_networks": [
      {
        "portal": {
          "url": "text",
          "version": "Version3"
        },
        "name": "text",
        "logo_url": "text",
        "icon_url": "text",
        "wallet_logo": "text",
        "address": "text",
        "address2": "text",
        "city": "text",
        "state": "text",
        "zip_code": "text",
        "country": "text",
        "email": "text",
        "website": "text",
        "foreground_color": "text",
        "background_color": "text"
      }
    ],
    "company_name": "text",
    "company_title": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "full_name": "text",
    "locale": "text",
    "is_member": false,
    "was_member": false,
    "has_applied": false,
    "flag": "",
    "email": "[e-mail]",
    "mobile": {
      "country_code": "text",
      "number": "text",
      "full": "text"
    },
    "phone": {
      "country_code": "text",
      "number": "text",
      "full": "text"
    },
    "profile_photo": "text",
    "vip": false,
    "home_house_id": "text",
    "birthdate": "text",
    "anniversary_date": "text",
    "created_on": "2024-10-06T20:37:18.971Z"
  }
]

Create a new customer

Requires admin privileges

POST/api/customers

Body

application/json

passwordnullable string

profile_photonullable string

advancedCustomerAdvanced (object)

categoryCustomerCategory (enum)

nonecontactprospectapplicantguestmember

addressAddressEntity (object)

usernamenullable string

gendernullable string

websitenullable string

socialSocial (object)

member_sincenullable string

house_account_enabledboolean

statusnullable string

typenullable string

customer_referencenullable string

latitudenullable string

longitudenullable string

sourcenullable string

modified_byinteger (int64)

attributesnullable array of CustomerAttribute (object)

modified_onnullable string

metaCustomerMeta (object)

global_networksnullable array of GlobalNetworkCompany (object)

idinteger (int64)

company_namenullable string

company_titlenullable string

first_namenullable string

middle_namenullable string

last_namenullable string

full_namenullable string

localenullable string

is_memberboolean

was_memberboolean

has_appliedboolean

flagCustomerFlag (enum)

changepwpendingVerificationmembership_failed_payment

emailnullable string (email)

mobilePhone (object)

phonePhone (object)

vipboolean

home_house_idnullable string

birthdatenullable string

anniversary_datenullable string

created_onstring (date-time)

Response

200400

OK

Body

application/json

advancedCustomerAdvanced (object)

categoryCustomerCategory (enum)

nonecontactprospectapplicantguestmember

addressAddressEntity (object)

usernamenullable string

gendernullable string

websitenullable string

socialSocial (object)

member_sincenullable string

house_account_enabledboolean

statusnullable string

typenullable string

customer_referencenullable string

latitudenullable string

longitudenullable string

sourcenullable string

modified_byinteger (int64)

attributesnullable array of CustomerAttribute (object)

modified_onnullable string

metaCustomerMeta (object)

global_networksnullable array of GlobalNetworkCompany (object)

idinteger (int64)

company_namenullable string

company_titlenullable string

first_namenullable string

middle_namenullable string

last_namenullable string

full_namenullable string

localenullable string

is_memberboolean

was_memberboolean

has_appliedboolean

flagCustomerFlag (enum)

changepwpendingVerificationmembership_failed_payment

emailnullable string (email)

mobilePhone (object)

phonePhone (object)

profile_photonullable string

vipboolean

home_house_idnullable string

birthdatenullable string

anniversary_datenullable string

created_onstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "advanced": {
    "opt_in_email": "text",
    "opt_in_sms": "text",
    "opt_in_updates": "text",
    "house_account_enabled": "text"
  },
  "category": "none",
  "address": {
    "address": "text",
    "address2": "text",
    "address3": "text",
    "city": "text",
    "state": "text",
    "zip_code": "text",
    "country": "text"
  },
  "username": "text",
  "gender": "text",
  "website": "text",
  "social": {
    "facebook": "text",
    "twitter": "text",
    "google": "text",
    "instagram": "text",
    "foursquare": "text",
    "linkedin": "text",
    "tiktok": "text"
  },
  "member_since": "text",
  "house_account_enabled": false,
  "status": "text",
  "type": "text",
  "customer_reference": "text",
  "latitude": "text",
  "longitude": "text",
  "source": "text",
  "attributes": [
    {
      "name": "text",
      "values": [
        "text"
      ]
    }
  ],
  "modified_on": "text",
  "meta": {
    "total_touchpoints": "text",
    "last_viewed": "text",
    "last_newsletter": "text",
    "last_touchpoint": "text",
    "last_communication": "text",
    "last_contacted": "text",
    "last_pageview": "text",
    "last_email_opened": "text",
    "last_login": "text",
    "last_viewed_by": "text",
    "app_installed": "text",
    "app_installed_on": "text"
  },
  "global_networks": [
    {
      "portal": {
        "url": "text",
        "version": "Version3"
      },
      "name": "text",
      "logo_url": "text",
      "icon_url": "text",
      "wallet_logo": "text",
      "address": "text",
      "address2": "text",
      "city": "text",
      "state": "text",
      "zip_code": "text",
      "country": "text",
      "email": "text",
      "website": "text",
      "foreground_color": "text",
      "background_color": "text"
    }
  ],
  "company_name": "text",
  "company_title": "text",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "full_name": "text",
  "locale": "text",
  "is_member": false,
  "was_member": false,
  "has_applied": false,
  "flag": "",
  "email": "[e-mail]",
  "mobile": {
    "country_code": "text",
    "number": "text",
    "full": "text"
  },
  "phone": {
    "country_code": "text",
    "number": "text",
    "full": "text"
  },
  "profile_photo": "text",
  "vip": false,
  "home_house_id": "text",
  "birthdate": "text",
  "anniversary_date": "text",
  "created_on": "2024-10-06T20:37:18.971Z"
}

Get a specific customer

Requires admin privileges

GET/api/customers/{customer_id}

Path parameters

customer_id*integer (int64)

Response

200400

OK

Body

application/json

advancedCustomerAdvanced (object)

categoryCustomerCategory (enum)

nonecontactprospectapplicantguestmember

addressAddressEntity (object)

usernamenullable string

gendernullable string

websitenullable string

socialSocial (object)

member_sincenullable string

house_account_enabledboolean

statusnullable string

typenullable string

customer_referencenullable string

latitudenullable string

longitudenullable string

sourcenullable string

modified_byinteger (int64)

attributesnullable array of CustomerAttribute (object)

modified_onnullable string

metaCustomerMeta (object)

global_networksnullable array of GlobalNetworkCompany (object)

idinteger (int64)

company_namenullable string

company_titlenullable string

first_namenullable string

middle_namenullable string

last_namenullable string

full_namenullable string

localenullable string

is_memberboolean

was_memberboolean

has_appliedboolean

flagCustomerFlag (enum)

changepwpendingVerificationmembership_failed_payment

emailnullable string (email)

mobilePhone (object)

phonePhone (object)

profile_photonullable string

vipboolean

home_house_idnullable string

birthdatenullable string

anniversary_datenullable string

created_onstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers/{customer_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "advanced": {
    "opt_in_email": "text",
    "opt_in_sms": "text",
    "opt_in_updates": "text",
    "house_account_enabled": "text"
  },
  "category": "none",
  "address": {
    "address": "text",
    "address2": "text",
    "address3": "text",
    "city": "text",
    "state": "text",
    "zip_code": "text",
    "country": "text"
  },
  "username": "text",
  "gender": "text",
  "website": "text",
  "social": {
    "facebook": "text",
    "twitter": "text",
    "google": "text",
    "instagram": "text",
    "foursquare": "text",
    "linkedin": "text",
    "tiktok": "text"
  },
  "member_since": "text",
  "house_account_enabled": false,
  "status": "text",
  "type": "text",
  "customer_reference": "text",
  "latitude": "text",
  "longitude": "text",
  "source": "text",
  "attributes": [
    {
      "name": "text",
      "values": [
        "text"
      ]
    }
  ],
  "modified_on": "text",
  "meta": {
    "total_touchpoints": "text",
    "last_viewed": "text",
    "last_newsletter": "text",
    "last_touchpoint": "text",
    "last_communication": "text",
    "last_contacted": "text",
    "last_pageview": "text",
    "last_email_opened": "text",
    "last_login": "text",
    "last_viewed_by": "text",
    "app_installed": "text",
    "app_installed_on": "text"
  },
  "global_networks": [
    {
      "portal": {
        "url": "text",
        "version": "Version3"
      },
      "name": "text",
      "logo_url": "text",
      "icon_url": "text",
      "wallet_logo": "text",
      "address": "text",
      "address2": "text",
      "city": "text",
      "state": "text",
      "zip_code": "text",
      "country": "text",
      "email": "text",
      "website": "text",
      "foreground_color": "text",
      "background_color": "text"
    }
  ],
  "company_name": "text",
  "company_title": "text",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "full_name": "text",
  "locale": "text",
  "is_member": false,
  "was_member": false,
  "has_applied": false,
  "flag": "",
  "email": "[e-mail]",
  "mobile": {
    "country_code": "text",
    "number": "text",
    "full": "text"
  },
  "phone": {
    "country_code": "text",
    "number": "text",
    "full": "text"
  },
  "profile_photo": "text",
  "vip": false,
  "home_house_id": "text",
  "birthdate": "text",
  "anniversary_date": "text",
  "created_on": "2024-10-06T20:37:18.971Z"
}

Update a customer

Requires admin privileges

PATCH/api/customers/{customer_id}

Path parameters

customer_id*integer (int64)

Body

application/json

passwordCustomerPassword (object)

advancedCustomerAdvanced (object)

categoryCustomerCategory (enum)

nonecontactprospectapplicantguestmember

addressAddressEntity (object)

usernamenullable string

gendernullable string

websitenullable string

socialSocial (object)

member_sincenullable string

house_account_enabledboolean

statusnullable string

typenullable string

customer_referencenullable string

latitudenullable string

longitudenullable string

sourcenullable string

modified_byinteger (int64)

attributesnullable array of CustomerAttribute (object)

modified_onnullable string

metaCustomerMeta (object)

global_networksnullable array of GlobalNetworkCompany (object)

idinteger (int64)

company_namenullable string

company_titlenullable string

first_namenullable string

middle_namenullable string

last_namenullable string

full_namenullable string

localenullable string

is_memberboolean

was_memberboolean

has_appliedboolean

flagCustomerFlag (enum)

changepwpendingVerificationmembership_failed_payment

emailnullable string (email)

mobilePhone (object)

phonePhone (object)

profile_photonullable string

vipboolean

home_house_idnullable string

birthdatenullable string

anniversary_datenullable string

created_onstring (date-time)

Response

200400

OK

Body

application/json

advancedCustomerAdvanced (object)

categoryCustomerCategory (enum)

nonecontactprospectapplicantguestmember

addressAddressEntity (object)

usernamenullable string

gendernullable string

websitenullable string

socialSocial (object)

member_sincenullable string

house_account_enabledboolean

statusnullable string

typenullable string

customer_referencenullable string

latitudenullable string

longitudenullable string

sourcenullable string

modified_byinteger (int64)

attributesnullable array of CustomerAttribute (object)

modified_onnullable string

metaCustomerMeta (object)

global_networksnullable array of GlobalNetworkCompany (object)

idinteger (int64)

company_namenullable string

company_titlenullable string

first_namenullable string

middle_namenullable string

last_namenullable string

full_namenullable string

localenullable string

is_memberboolean

was_memberboolean

has_appliedboolean

flagCustomerFlag (enum)

changepwpendingVerificationmembership_failed_payment

emailnullable string (email)

mobilePhone (object)

phonePhone (object)

profile_photonullable string

vipboolean

home_house_idnullable string

birthdatenullable string

anniversary_datenullable string

created_onstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers/{customer_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "advanced": {
    "opt_in_email": "text",
    "opt_in_sms": "text",
    "opt_in_updates": "text",
    "house_account_enabled": "text"
  },
  "category": "none",
  "address": {
    "address": "text",
    "address2": "text",
    "address3": "text",
    "city": "text",
    "state": "text",
    "zip_code": "text",
    "country": "text"
  },
  "username": "text",
  "gender": "text",
  "website": "text",
  "social": {
    "facebook": "text",
    "twitter": "text",
    "google": "text",
    "instagram": "text",
    "foursquare": "text",
    "linkedin": "text",
    "tiktok": "text"
  },
  "member_since": "text",
  "house_account_enabled": false,
  "status": "text",
  "type": "text",
  "customer_reference": "text",
  "latitude": "text",
  "longitude": "text",
  "source": "text",
  "attributes": [
    {
      "name": "text",
      "values": [
        "text"
      ]
    }
  ],
  "modified_on": "text",
  "meta": {
    "total_touchpoints": "text",
    "last_viewed": "text",
    "last_newsletter": "text",
    "last_touchpoint": "text",
    "last_communication": "text",
    "last_contacted": "text",
    "last_pageview": "text",
    "last_email_opened": "text",
    "last_login": "text",
    "last_viewed_by": "text",
    "app_installed": "text",
    "app_installed_on": "text"
  },
  "global_networks": [
    {
      "portal": {
        "url": "text",
        "version": "Version3"
      },
      "name": "text",
      "logo_url": "text",
      "icon_url": "text",
      "wallet_logo": "text",
      "address": "text",
      "address2": "text",
      "city": "text",
      "state": "text",
      "zip_code": "text",
      "country": "text",
      "email": "text",
      "website": "text",
      "foreground_color": "text",
      "background_color": "text"
    }
  ],
  "company_name": "text",
  "company_title": "text",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "full_name": "text",
  "locale": "text",
  "is_member": false,
  "was_member": false,
  "has_applied": false,
  "flag": "",
  "email": "[e-mail]",
  "mobile": {
    "country_code": "text",
    "number": "text",
    "full": "text"
  },
  "phone": {
    "country_code": "text",
    "number": "text",
    "full": "text"
  },
  "profile_photo": "text",
  "vip": false,
  "home_house_id": "text",
  "birthdate": "text",
  "anniversary_date": "text",
  "created_on": "2024-10-06T20:37:18.971Z"
}