API Reference
helcim.com

Get customers

get
https://api.helcim.com/v2/customers/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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

string

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

integer

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.

integer

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

string

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

  • yes - return all available cards for retrieved customers.
Responses

Updated about 1 year ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago