HEhelcim
Customer

Get customers

get/customers

Request

  • Base URL
    https://api.helcim.com/v2
  • URL
    https://api.helcim.com/v2/customers
  • Auth
    API key in header api-token

Query parameters

searchstring

The search term to be used for partial matching on contactName, businessName, customerCode, city, phone and email (Only use one query field per request).

customerCodestring

Existing customer code (Only use one query field per request).

limitinteger

The limit number of customers will be returned in one request. We only allow maximum 100 objects per request. If no limit specified, the default limit will be 100 objects.

pageinteger

Specifies the page number of the results you want to retrieve.

includeCardsstring

Specifies whether to return any credit cards for retrieved customers. By default no cards are returned.

  • yes - return all available cards for retrieved customers.

Response

Successful

idinteger

Id of Customer

customerCodestring

Customer code of the customer

businessNamestring

Name of the business

contactNamestring

Contact Name

cellPhonestring

Cell phone number of customer

Example response

[
  {
    "id": 2488717,
    "customerCode": "CST1200",
    "businessName": "Best company",
    "contactName": "John Smith",
    "cellPhone": "908-295-4902",
    "billingAddress": {
      "name": "John Smith / Helcim",
      "street1": "21 Jump Street",
      "street2": "Suite 400",
      "city": "Calgary",
      "province": "AB",
      "country": "CAN",
      "postalCode": "H0H0H0",
      "email": "john@example.com"
    },
    "shippingAddress": {
      "name": "John Smith / Helcim",
      "street1": "21 Jump Street",
      "street2": "Suite 400",
      "city": "Calgary",
      "province": "AB",
      "country": "CAN",
      "postalCode": "H0H0H0",
      "email": "john@example.com"
    },
    "cards": [
      {
        "cardHolderName": "John Smith",
        "cardToken": "a1b2c3d4e5f6"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.