List all customers - LogicTrade API

Returns a list of your customers. The customers are returned sorted by id, with the most recent customer appearing first.

Request

Authorization

Add parameter in header

api-key

Example:

api-key: ********************

Query Params

pageSize

integer

optional

This specifies the number of objects to returned, ranging between 10 and 100.

Example:

100

pageNumber

integer

optional

The parameter pageNumber indicates which page of the result should be requested.

Example:

name

string

optional

Search for a specific customer based on the provided name.

number

string

optional

Search for a specific customer based on the provided number.

zipCodeHouseNumber

string

optional

Search for a specific customer based on the provided zip code and house number.

city

string

optional

Search for all customers based on the provided city.

string

optional

Search for a specific customer based on the provided email.

phoneNumber

string

optional

Search for a specific customer based on the provided phone number.

modifiedAfter

string <date-time>

optional

Search for all customers that have been modified after the specified timestamp.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

pagination

object

optional

totalResults

integer

optional

The total number of records.

pageNumber

integer

optional

The current page number.

pageSize

integer

optional

The number of records returned per page.

totalPages

integer

optional

The total number of pages.

results

array [object {24}]

required

integer

read-onlyrequired

The unique identifier of the customer.

number

string

read-onlyoptional

A unique number with which the customer can be found.

gender

string

optional

The customer's gender male/female/unknown

title

string

optional

The title of the relation.

initials

string

optional

The customer's initials.

firstName

string

optional

The customer's first name.

infix

string

optional

The infix of the relation. A new one will be created if the infix does not exist.

lastName

string

optional

The customer's last name.

companyName

string

optional

Only filled if it is a business customer and contains the customer's company name.

cocNumber

string

optional

Chain of Custody Number (KvK number).

vatNumber

string

optional

The VAT number (BTW nummer) of the customer.

phoneNumber

string

optional

The first phone number of the customer.

phoneNumber2

string

optional

The second phone number of the customer.

mobileNumber

string

optional

The mobile phone number of the customer.

string

optional

The e-mail adress of the customer

remark

string

optional

Any customer comments.

address

object

optional

The address of the customer.

invoiceAddress

object

optional

The invoice address of the customer.

deliveryAddress

object

optional

The delivery address of the customer.

newsLetter

boolean

optional

This indicates whether the customer wants to receive a newsletter.

externNumbers

object

optional

In this section, the external numbers are displayed. These numbers can be used by external applications.

birthdate

string <date>

optional

The customer’s birthdate.

modifiedDate

string <date-time>

optional

The date on which the entity was last modified.

createdDate

string <date-time>

optional

The date on which the entity was created.

Example

{
  "pagination": {
    "totalResults": 2,
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1
  },
  "results": [
    {
      "id": 13,
      "number": "R0000013",
      "companyName": "LogicTrade",
      "phoneNumber": "088-2400180",
      "email": "info@logictrade.nl",
      "address": {
        "street": "Wethouder Buitenhuisstraat",
        "houseNumber": "2B",
        "zipCode": "7951 SM",
        "city": "Staphorst",
        "country": "NL"
      }
    },
    {
      "id": 14,
      "number": "R0000016",
      "gender": "male",
      "title": "Dhr.",
      "initials": "J.",
      "firstName": "Jan",
      "lastName": "Jansen",
      "mobileNumber": "06-12345678",
      "email": "jan@jansen.com",
      "remark": "Niet beschikbaar op maandag en dinsdag!",
      "address": {
        "street": "Wethouder Buitenhuisstraat",
        "houseNumber": "2B",
        "zipCode": "7951 SM",
        "city": "Staphorst",
        "country": "NL"
      }
    }
  ]
}

🟢204No Content

🟠401Unauthorized

🟠400Bad Request