Retrieve a customer by id - LogicTrade API

Request

Authorization

Add parameter in header

api-key

Example:

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

Path Params

id

string

required

The id of the customer

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

id

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.

email

string

optional

The e-mail adress of the customer

remark

string

optional

Any customer comments.

address

object

optional

The address of the customer.

name

string

optional

street

string

optional

houseNumber

string

optional

zipCode

string

optional

city

string

optional

country

string

optional

phoneNumber

string

optional

invoiceAddress

object

optional

The invoice address of the customer.

name

string

optional

street

string

optional

houseNumber

string

optional

zipCode

string

optional

city

string

optional

country

string

optional

phoneNumber

string

optional

deliveryAddress

object

optional

The delivery address of the customer.

name

string

optional

street

string

optional

houseNumber

string

optional

zipCode

string

optional

city

string

optional

country

string

optional

phoneNumber

string

optional

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.

number1

string

optional

number2

string

optional

number3

string

optional

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

{
  "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"
  }
}

🟠401Unauthorized

🟠404Record Not Found