AlphaAlpha Docs
API Reference

Clients

Clients API

Create a new client

POST
/clients

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/clients" \  -H "Content-Type: application/json" \  -d '{    "billingAddress": {      "city": "string",      "country": "string",      "id": "string",      "postalCode": "string",      "street": "string"    },    "contacts": [      {        "email": "string",        "firstName": "string",        "id": "string",        "lastName": "string",        "phone": "string"      }    ],    "deliveryAddresses": [      {        "city": "string",        "country": "string",        "id": "string",        "postalCode": "string",        "street": "string"      }    ],    "email": "string",    "name": "string",    "type": "PERSON"  }'
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "ownerId": "string",
  "phone": "string",
  "preferredLanguage": "string",
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "visits": [
    {
      "frequency": 0,
      "ip": "string",
      "time": "2019-08-24T14:15:22Z"
    }
  ],
  "website": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Download Csv_ Client

GET
/clients/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/clients/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of entities by their IDs

DELETE
/clients/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/clients/delete-list?ids=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Client

GET
/clients/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/clients/dynamic-search"
{
  "content": [
    {
      "avatar": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "billingAddress": {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      },
      "btw": "string",
      "contacts": [
        {
          "department": "string",
          "email": "string",
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "phone": "string"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "crmStatus": "LEAD",
      "deliveryAddresses": [
        {
          "city": "string",
          "country": "string",
          "houseNumber": "string",
          "id": "string",
          "latitude": 0.1,
          "longitude": 0.1,
          "postalCode": "string",
          "street": "string"
        }
      ],
      "email": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "industry": "string",
      "kvk": "string",
      "leadSource": "string",
      "name": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "phone": "string",
      "preferredLanguage": "string",
      "region": "string",
      "subsidiaryId": "string",
      "tags": [
        "string"
      ],
      "tenantId": "string",
      "type": "PERSON",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "userId": "string",
      "visits": [
        {
          "frequency": 0,
          "ip": "string",
          "time": "2019-08-24T14:15:22Z"
        }
      ],
      "website": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Client

POST
/clients/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/clients/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "avatar": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "billingAddress": {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      },
      "btw": "string",
      "contacts": [
        {
          "department": "string",
          "email": "string",
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "phone": "string"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "crmStatus": "LEAD",
      "deliveryAddresses": [
        {
          "city": "string",
          "country": "string",
          "houseNumber": "string",
          "id": "string",
          "latitude": 0.1,
          "longitude": 0.1,
          "postalCode": "string",
          "street": "string"
        }
      ],
      "email": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "industry": "string",
      "kvk": "string",
      "leadSource": "string",
      "name": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "phone": "string",
      "preferredLanguage": "string",
      "region": "string",
      "subsidiaryId": "string",
      "tags": [
        "string"
      ],
      "tenantId": "string",
      "type": "PERSON",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "userId": "string",
      "visits": [
        {
          "frequency": 0,
          "ip": "string",
          "time": "2019-08-24T14:15:22Z"
        }
      ],
      "website": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/clients/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/clients/find"
[
  {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "billingAddress": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "btw": "string",
    "contacts": [
      {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "crmStatus": "LEAD",
    "deliveryAddresses": [
      {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      }
    ],
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "industry": "string",
    "kvk": "string",
    "leadSource": "string",
    "name": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "phone": "string",
    "preferredLanguage": "string",
    "region": "string",
    "subsidiaryId": "string",
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "PERSON",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "userId": "string",
    "visits": [
      {
        "frequency": 0,
        "ip": "string",
        "time": "2019-08-24T14:15:22Z"
      }
    ],
    "website": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/clients/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/clients/find-all"
[
  {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "billingAddress": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "btw": "string",
    "contacts": [
      {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "crmStatus": "LEAD",
    "deliveryAddresses": [
      {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      }
    ],
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "industry": "string",
    "kvk": "string",
    "leadSource": "string",
    "name": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "phone": "string",
    "preferredLanguage": "string",
    "region": "string",
    "subsidiaryId": "string",
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "PERSON",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "userId": "string",
    "visits": [
      {
        "frequency": 0,
        "ip": "string",
        "time": "2019-08-24T14:15:22Z"
      }
    ],
    "website": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/clients/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/clients/find-list"
[
  {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "billingAddress": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "btw": "string",
    "contacts": [
      {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "crmStatus": "LEAD",
    "deliveryAddresses": [
      {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      }
    ],
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "industry": "string",
    "kvk": "string",
    "leadSource": "string",
    "name": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "phone": "string",
    "preferredLanguage": "string",
    "region": "string",
    "subsidiaryId": "string",
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "PERSON",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "userId": "string",
    "visits": [
      {
        "frequency": 0,
        "ip": "string",
        "time": "2019-08-24T14:15:22Z"
      }
    ],
    "website": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/clients/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/clients/find/string"
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "ownerId": "string",
  "phone": "string",
  "preferredLanguage": "string",
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "visits": [
    {
      "frequency": 0,
      "ip": "string",
      "time": "2019-08-24T14:15:22Z"
    }
  ],
  "website": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/clients/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/clients/page"
{
  "content": [
    {
      "avatar": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "billingAddress": {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      },
      "btw": "string",
      "contacts": [
        {
          "department": "string",
          "email": "string",
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "phone": "string"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "crmStatus": "LEAD",
      "deliveryAddresses": [
        {
          "city": "string",
          "country": "string",
          "houseNumber": "string",
          "id": "string",
          "latitude": 0.1,
          "longitude": 0.1,
          "postalCode": "string",
          "street": "string"
        }
      ],
      "email": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "industry": "string",
      "kvk": "string",
      "leadSource": "string",
      "name": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "phone": "string",
      "preferredLanguage": "string",
      "region": "string",
      "subsidiaryId": "string",
      "tags": [
        "string"
      ],
      "tenantId": "string",
      "type": "PERSON",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "userId": "string",
      "visits": [
        {
          "frequency": 0,
          "ip": "string",
          "time": "2019-08-24T14:15:22Z"
        }
      ],
      "website": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update an existing client

PATCH
/clients/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/clients/string" \  -H "Content-Type: application/json" \  -d '{    "billingAddress": {      "city": "string",      "country": "string",      "id": "string",      "postalCode": "string",      "street": "string"    },    "contacts": [      {        "email": "string",        "firstName": "string",        "id": "string",        "lastName": "string",        "phone": "string"      }    ],    "deliveryAddresses": [      {        "city": "string",        "country": "string",        "id": "string",        "postalCode": "string",        "street": "string"      }    ],    "email": "string",    "name": "string",    "type": "PERSON"  }'
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "ownerId": "string",
  "phone": "string",
  "preferredLanguage": "string",
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "visits": [
    {
      "frequency": 0,
      "ip": "string",
      "time": "2019-08-24T14:15:22Z"
    }
  ],
  "website": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/clients/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/clients/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Upload client avatar

POST
/clients/{id}/avatar

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/clients/string/avatar" \  -H "Content-Type: application/json" \  -d '{    "file": "string"  }'
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "ownerId": "string",
  "phone": "string",
  "preferredLanguage": "string",
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "visits": [
    {
      "frequency": 0,
      "ip": "string",
      "time": "2019-08-24T14:15:22Z"
    }
  ],
  "website": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/clients/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/clients/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Changelog

Previous Page

Communication Settings

Next Page