Customers

List all Customers

Returns a list of your Customers.

get/admin/customers/customer

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/customers/customer
Auth: HTTP basic

Response

loginstring

statusstring

Status: 'new', 'active', 'blocked', 'disabled'. Default value: 'new'

partner_idnumber required

Partner id. You can get it at page "Administration / Partners"

location_idnumber required

Location id. You can get it at page "Administration / Locations"

parent_idnumber

ID of the main (parent) account.

namestring required

Full name

emailstring

billing_emailstring

Billing email

phonestring

Phone number

categorystring required

Category: 'person' (for private person) or 'company' (for company). Default value: 'person'

street_1string

Address part #1

zip_codestring

Zip

citystring

City

date_addstring

Date of adding. Format: 'YYYY-MM-DD'. Default value: current date

subdivision_idnumber

State/province ID

conversion_datestring

Date conversion customer.

daily_prepaid_costnumber

Cost of daily prepayment.

passwordstring

Password

gpsstring

Geo data customer. Format: '49.9902794,36.2303893'.

mrr_totalnumber

Mrr total. Default value: 0.0000.

billing_typestring

Billing type.

added_bystring

Source of customer addition (e.g. 'admin', 'api').

added_by_idnumber

Id of the administrator who added the customer.

last_onlinestring

Date last online customer.

last_updatestring

Last date update customer.

account_type'regular' | 'main' | 'sub_independent' | 'sub_aggregated'

Read-only. Account type. Shows only if sub accounts are used in the system

can_manage_aggregated_sub_accounts'0' | '1'

Read-only. Whether this account can manage its linked aggregated sub-accounts: 1 for a main account that has sub-account management enabled, otherwise 0. Shows only if sub accounts are used in the system.

idnumber required

Customer ID

Example response

[
  {
    "login": "john_doe",
    "status": "new",
    "partner_id": 1,
    "location_id": 1,
    "parent_id": 0,
    "name": "John Doe",
    "email": "john.doe@domain.com",
    "billing_email": "john.doe.billing@domain.com",
    "phone": "555-0134",
    "category": "person",
    "street_1": "Paper Street",
    "zip_code": "",
    "city": "",
    "date_add": "",
    "customer_labels": [
      {
        "id": 1,
        "label": "Label name",
        "color": "#357bf2"
      }
    ],
    "subdivision_id": 1,
    "conversion_date": "",
    "daily_prepaid_cost": 0,
    "id": 1,
    "password": "marla_my_love",
    "gps": "",
    "mrr_total": 0,
    "billing_type": "",
    "added_by": "admin",
    "added_by_id": 1,
    "last_online": "",
    "last_update": "",
    "account_type": "regular",
    "can_manage_aggregated_sub_accounts": "0",
    "contacts": [
      {
        "id": 1,
        "type": "email",
        "value": "john.doe@domain.com",
        "label": "primary",
        "country_code": null,
        "is_primary": true,
        "is_whatsapp": false
      },
      {
        "id": 2,
        "type": "email",
        "value": "john.doe.billing@domain.com",
        "label": "billing",
        "country_code": null,
        "is_primary": true,
        "is_whatsapp": false
      },
      {
        "id": 3,
        "type": "phone",
        "value": "555-0134",
        "label": "primary",
        "country_code": null,
        "is_primary": true,
        "is_whatsapp": false
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.