Developer Center

Client Types API

Last Updated: Feb 20, 2017 04:32PM CET

URL

/api/clienttypes

Description

Retrieves all the client types in the organisation

Methods

GET ClientTypes

Get a list of client types in JSON format.

Optional parameters

for Filters client types. The valid options are CLIENTS or GROUPS

Usage examples

// Get all client types
GET /api/clienttypes

// Get all types for clients
GET /api/clienttypes?for=CLIENTS

// Get all types for groups
GET /api/clienttypes?for=GROUPS

Sample responses

A 200 OK response will be issued with a list of client types.
[
   {
      "encodedKey":"8a3e435149cd61eb0149cd74b1cb003b",
      "name":"Client",
      "id":"client",
      "clientType":"CLIENT",
      "creationDate":"2014-11-20T13:46:57+0000",
      "canOpenAccounts":true,
      "canGuarantee":true,
      "requireID":false,
      "index":-1
   },
   {
      "encodedKey":"8a0ca02a4ba46b0d014ba74fc5a30c00",
      "name":"Power of Attorney holders",
      "id":"Power",
      "clientType":"CLIENT",
      "creationDate":"2015-02-20T14:06:38+0000",
      "createdByUserKey":"8a8603b4497abb2101497b6c59cc0b33",
      "canOpenAccounts":false,
      "canGuarantee":false,
      "requireID":false,
      "index":2147483647
   },
   {
      "encodedKey":"8a3edf494b25cedc014b2661f6d300b9",
      "name":"Guarantor",
      "id":"Guarantor",
      "clientType":"CLIENT",
      "creationDate":"2015-01-26T13:15:29+0000",
      "createdByUserKey":"8a8603b4497abb2101497b6c59cc0b33",
      "canOpenAccounts":false,
      "canGuarantee":true,
      "requireID":true,
      "index":2147483647
   },
   {
      "encodedKey":"8a3e435149cd61eb0149cd74b9560044",
      "name":"Group",
      "id":"group",
      "clientType":"GROUP",
      "creationDate":"2014-11-20T13:46:59+0000",
      "canOpenAccounts":true,
      "canGuarantee":false,
      "requireID":false,
      "index":-1
   }
]
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete