Skip to content

Customers

Returns list of customers in the system. Returned data can be limited with customer_id query parameters.

Operations

Download customers as JSON

Request

GET https://api.zoined.com/v2/download/customers.json?limit=1000&offset=0&customer_id=123k

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
customer_idstring

Returns data of customer based on the given id

Example:customer_id=123k
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/customers.json?limit=1000&offset=0&customer_id=123k' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
customer_idstringrequired

Customer ID

Example:"32"
customer_namestring

Customer Name

Example:"John Smith"
customer_companystring

Customer Company

Example:"Smith Industries"
customer_emailstring

Customer Email

Example:"john.smith@customer.customer"
customer_phonestring

Customer Phone

Example:"+35811111111"
customer_addressstring

Customer Street Address

Example:"Mannerheimintie 1"
customer_zipcodestring

Customer's Zip Code

Example:"00100"
customer_citystring

Customer City

Example:"Helsinki"
customer_countrystring

Customer Country

Example:"Finland"
account_numberstring

45 (string, optional) - Account number

Example:"123"
vat_numberstring

9 (string, optional) - VAT Number

Example:"12345678"
organisation_idstring

Customer account store ID

Example:"1"
salesperson_idstring

Customer account sales person ID

Example:"3"
creation_datestring

Date when this customer was added to system (yyyy-mm-dd).

Example:"2021-12-15"
subscribe_datestring

Date when this customer subscribed newsletter (yyyy-mm-dd).

Example:"2022-01-15"
unsubscribe_datestring

Date when this customer unsubscribed newsletter (yyyy-mm-dd).

Example:"2022-02-15"
register_datestring

Date when this customer registered to system (yyyy-mm-dd).

Example:"2022-01-10"
unregister_datestring

Date when this customer unregistered from system (yyyy-mm-dd).

Example:"2022-03-15"
custom_dimension_1string

Custom Field 1

Example:"Class 3"
custom_dimension_2string

Custom Field 2

Example:"Class 3"
custom_dimension_3string

Custom Field 3

Example:"Class 3"
custom_dimension_4string

Custom Field 4

Example:"Class 3"
custom_dimension_5string

Custom Field 5

Example:"Class 3"
custom_dimension_6string

Custom Field 6

Example:"Class 3"
custom_dimension_7string

Custom Field 7

Example:"Class 3"
custom_dimension_8string

Custom Field 8

Example:"Class 3"
custom_dimension_9string

Custom Field 9

Example:"Class 3"
custom_dimension_10string

Custom Field 10

Example:"Class 3"
custom_dimension_11string

Custom Field 11

Example:"Class 3"
custom_dimension_12string

Custom Field 12

Example:"Class 3"
custom_dimension_13string

Custom Field 13

Example:"Class 3"
custom_dimension_14string

Custom Field 14

Example:"Class 3"
custom_dimension_15string

Custom Field 15

Example:"Class 3"
custom_dimension_16string

Custom Field 16

Example:"Class 3"
custom_dimension_17string

Custom Field 17

Example:"Class 3"
custom_dimension_18string

Custom Field 18

Example:"Class 3"
custom_dimension_19string

Custom Field 19

Example:"Class 3"
custom_dimension_20string

Custom Field 20

Example:"Class 3"
custom_dimension_21string

Custom Field 21

Example:"Class 3"
custom_dimension_22string

Custom Field 22

Example:"Class 3"
custom_dimension_23string

Custom Field 23

Example:"Class 3"
custom_dimension_24string

Custom Field 24

Example:"Class 3"
custom_dimension_25string

Custom Field 25

Example:"Class 3"
custom_dimension_26string

Custom Field 26

Example:"Class 3"
custom_dimension_27string

Custom Field 27

Example:"Class 3"
custom_dimension_28string

Custom Field 28

Example:"Class 3"
custom_dimension_29string

Custom Field 29

Example:"Class 3"
custom_dimension_30string

Custom Field 30

Example:"Class 3"
custom_dimension_31string

Custom Field 31

Example:"Class 3"
custom_dimension_32string

Custom Field 32

Example:"Class 3"
custom_dimension_33string

Custom Field 33

Example:"Class 3"
custom_dimension_34string

Custom Field 34

Example:"Class 3"
custom_dimension_35string

Custom Field 35

Example:"Class 3"
custom_dimension_36string

Custom Field 36

Example:"Class 3"
custom_dimension_37string

Custom Field 37

Example:"Class 3"
custom_dimension_38string

Custom Field 38

Example:"Class 3"
custom_dimension_39string

Custom Field 39

Example:"Class 3"
custom_dimension_40string

Custom Field 40

Example:"Class 3"
custom_dimension_41string

Custom Field 41

Example:"Class 3"
custom_dimension_42string

Custom Field 42

Example:"Class 3"
custom_dimension_43string

Custom Field 43

Example:"Class 3"
custom_dimension_44string

Custom Field 44

Example:"Class 3"
custom_dimension_45string

Custom Field 45

Example:"Class 3"
custom_dimension_46string

Custom Field 46

Example:"Class 3"
custom_dimension_47string

Custom Field 47

Example:"Class 3"
custom_dimension_48string

Custom Field 48

Example:"Class 3"
custom_dimension_49string

Custom Field 49

Example:"Class 3"
custom_dimension_50string

Custom Field 50

Example:"Class 3"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
Response
{
  "customer_id": "32",
  "customer_name": "John Smith",
  "customer_company": "Smith Industries",
  "customer_email": "john.smith@customer.customer",
  "customer_phone": "+35811111111",
  "customer_address": "Mannerheimintie 1",
  "customer_zipcode": "00100",
  "customer_city": "Helsinki",
  "customer_country": "Finland",
  "account_number": "123",
  "vat_number": "12345678",
  "organisation_id": "1",
  "salesperson_id": "3",
  "creation_date": "2021-12-15",
  "subscribe_date": "2022-01-15",
  "unsubscribe_date": "2022-02-15",
  "register_date": "2022-01-10",
  "unregister_date": "2022-03-15",
  "custom_dimension_1": "Class 3",
  "custom_dimension_2": "Class 3",
  "custom_dimension_3": "Class 3",
  "custom_dimension_4": "Class 3",
  "custom_dimension_5": "Class 3",
  "custom_dimension_6": "Class 3",
  "custom_dimension_7": "Class 3",
  "custom_dimension_8": "Class 3",
  "custom_dimension_9": "Class 3",
  "custom_dimension_10": "Class 3",
  "custom_dimension_11": "Class 3",
  "custom_dimension_12": "Class 3",
  "custom_dimension_13": "Class 3",
  "custom_dimension_14": "Class 3",
  "custom_dimension_15": "Class 3",
  "custom_dimension_16": "Class 3",
  "custom_dimension_17": "Class 3",
  "custom_dimension_18": "Class 3",
  "custom_dimension_19": "Class 3",
  "custom_dimension_20": "Class 3",
  "custom_dimension_21": "Class 3",
  "custom_dimension_22": "Class 3",
  "custom_dimension_23": "Class 3",
  "custom_dimension_24": "Class 3",
  "custom_dimension_25": "Class 3",
  "custom_dimension_26": "Class 3",
  "custom_dimension_27": "Class 3",
  "custom_dimension_28": "Class 3",
  "custom_dimension_29": "Class 3",
  "custom_dimension_30": "Class 3",
  "custom_dimension_31": "Class 3",
  "custom_dimension_32": "Class 3",
  "custom_dimension_33": "Class 3",
  "custom_dimension_34": "Class 3",
  "custom_dimension_35": "Class 3",
  "custom_dimension_36": "Class 3",
  "custom_dimension_37": "Class 3",
  "custom_dimension_38": "Class 3",
  "custom_dimension_39": "Class 3",
  "custom_dimension_40": "Class 3",
  "custom_dimension_41": "Class 3",
  "custom_dimension_42": "Class 3",
  "custom_dimension_43": "Class 3",
  "custom_dimension_44": "Class 3",
  "custom_dimension_45": "Class 3",
  "custom_dimension_46": "Class 3",
  "custom_dimension_47": "Class 3",
  "custom_dimension_48": "Class 3",
  "custom_dimension_49": "Class 3",
  "custom_dimension_50": "Class 3",
  "custom_metric_1": 1,
  "custom_metric_2": 100,
  "custom_metric_3": 2.2,
  "custom_metric_4": 1.05,
  "custom_metric_5": 10000
}