Clients

The endpoints available in this documentation empower you to perform various client-related operations, facilitating effective client engagement and organization.

Explore the following functionalities to manage clients:

• Add Client: Create new clients within the platform, supplying the necessary client details via the designated endpoint.

• Search Clients: Retrieve clients based on specified parameters or keywords, allowing for efficient search capabilities.

• Get Client by ID: Fetch detailed information about a specific client using their unique identifier.

• Update Client: Modify and update client information, ensuring accurate and up-to-date records.

• Add Client Tag: Associate tags with clients, enabling categorization and streamlined organization.

• Remove Client Tag: Effortlessly remove tags associated with clients, facilitating flexible tag management.

• Remove Client: Delete clients from the platform, facilitating data management and organization.

Creates a new client based on parameters

POSThttps://<YOUR HOST>/v1/clients

Header parameters

Body

application/json

idstring

fullName*string

contactTypeenum

HOMEMOBILEWORK

countryCode*string

phone*string

emailstring

registrationDatestring

dobstring

addressTypeenum

HOMEWORK

addressstring

genderenum

MaleFemaleUnknownOther

maritalStatusenum

UNMARRIEDMARRIEDOTHER

tagsarray of string

notesstring

referralSourcestring

primaryLocationobject

primaryStaffobject

customFieldsobject

photoUrlstring (uri)

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

Response

200

200 response

Body

application/json

idstring

fullName*string

contactTypeenum

HOMEMOBILEWORK

countryCode*string

phone*string

emailstring

registrationDatestring

dobstring

addressTypeenum

HOMEWORK

addressstring

genderenum

MaleFemaleUnknownOther

maritalStatusenum

UNMARRIEDMARRIEDOTHER

tagsarray of string

notesstring

referralSourcestring

primaryLocationobject

primaryStaffobject

customFieldsobject

photostring (uri)

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clients', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "countryCode": "text",
      "fullName": "text",
      "phone": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "fullName": "text",
  "contactType": "HOME",
  "countryCode": "text",
  "phone": "text",
  "email": "text",
  "registrationDate": "text",
  "dob": "text",
  "addressType": "HOME",
  "address": "text",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "text"
  ],
  "notes": "text",
  "referralSource": "text",
  "primaryLocation": {
    "id": "text",
    "title": "text"
  },
  "primaryStaff": {
    "id": "text"
  },
  "customFields": {},
  "photo": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}

Search clients based on parameters

GEThttps://<YOUR HOST>/v1/clients

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

fullName*string

contactTypeenum

HOMEMOBILEWORK

countryCode*string

phone*string

emailstring

registrationDatestring

dobstring

addressTypeenum

HOMEWORK

addressstring

genderenum

MaleFemaleUnknownOther

maritalStatusenum

UNMARRIEDMARRIEDOTHER

tagsarray of string

notesstring

referralSourcestring

primaryLocationobject

primaryStaffobject

customFieldsobject

photostring (uri)

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clients', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "fullName": "text",
    "contactType": "HOME",
    "countryCode": "text",
    "phone": "text",
    "email": "text",
    "registrationDate": "text",
    "dob": "text",
    "addressType": "HOME",
    "address": "text",
    "gender": "Male",
    "maritalStatus": "UNMARRIED",
    "tags": [
      "text"
    ],
    "notes": "text",
    "referralSource": "text",
    "primaryLocation": {
      "id": "text",
      "title": "text"
    },
    "primaryStaff": {
      "id": "text"
    },
    "customFields": {},
    "photo": "https://example.com",
    "emergencyRelationType": "text",
    "emergencyName": "text",
    "emergencyCountryCode": "text",
    "identificationNumber": "text",
    "emergencyPhone": "text"
  }
]

Please do note the {clientId} in the URL path denotes the UUID - Id of the client.

E.g. 5tw9zcQkbu

Gets a Client by Id

GEThttps://<YOUR HOST>/v1/clients/{clientId}

Path parameters

clientId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

fullName*string

contactTypeenum

HOMEMOBILEWORK

countryCode*string

phone*string

emailstring

registrationDatestring

dobstring

addressTypeenum

HOMEWORK

addressstring

genderenum

MaleFemaleUnknownOther

maritalStatusenum

UNMARRIEDMARRIEDOTHER

tagsarray of string

notesstring

referralSourcestring

primaryLocationobject

primaryStaffobject

customFieldsobject

photostring (uri)

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clients/{clientId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "fullName": "text",
  "contactType": "HOME",
  "countryCode": "text",
  "phone": "text",
  "email": "text",
  "registrationDate": "text",
  "dob": "text",
  "addressType": "HOME",
  "address": "text",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "text"
  ],
  "notes": "text",
  "referralSource": "text",
  "primaryLocation": {
    "id": "text",
    "title": "text"
  },
  "primaryStaff": {
    "id": "text"
  },
  "customFields": {},
  "photo": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}

Updates a particular client

PUThttps://<YOUR HOST>/v1/clients/{clientId}

Path parameters

clientId*string

Header parameters

Body

application/json

idstring

fullName*string

contactTypeenum

HOMEMOBILEWORK

countryCode*string

phone*string

emailstring

registrationDatestring

dobstring

addressTypeenum

HOMEWORK

addressstring

genderenum

MaleFemaleUnknownOther

maritalStatusenum

UNMARRIEDMARRIEDOTHER

tagsarray of string

notesstring

referralSourcestring

primaryLocationobject

primaryStaffobject

customFieldsobject

photoUrlstring (uri)

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

Response

200

200 response

Body

application/json

idstring

fullName*string

contactTypeenum

HOMEMOBILEWORK

countryCode*string

phone*string

emailstring

registrationDatestring

dobstring

addressTypeenum

HOMEWORK

addressstring

genderenum

MaleFemaleUnknownOther

maritalStatusenum

UNMARRIEDMARRIEDOTHER

tagsarray of string

notesstring

referralSourcestring

primaryLocationobject

primaryStaffobject

customFieldsobject

photostring (uri)

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clients/{clientId}', {
    method: 'PUT',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "countryCode": "text",
      "fullName": "text",
      "phone": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "fullName": "text",
  "contactType": "HOME",
  "countryCode": "text",
  "phone": "text",
  "email": "text",
  "registrationDate": "text",
  "dob": "text",
  "addressType": "HOME",
  "address": "text",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "text"
  ],
  "notes": "text",
  "referralSource": "text",
  "primaryLocation": {
    "id": "text",
    "title": "text"
  },
  "primaryStaff": {
    "id": "text"
  },
  "customFields": {},
  "photo": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}

Deletes a client based on clientId

DELETEhttps://<YOUR HOST>/v1/clients/{clientId}

Path parameters

clientId*string

Header parameters

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clients/{clientId}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false
}

POSThttps://<YOUR HOST>/v1/clients/{clientId}/tags/add

Path parameters

clientId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

tagsarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clients/{clientId}/tags/add', {
    method: 'POST',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "tags": [
    "text"
  ]
}

POSThttps://<YOUR HOST>/v1/clients/{clientId}/tags/remove

Path parameters

clientId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

tagsarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clients/{clientId}/tags/remove', {
    method: 'POST',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "tags": [
    "text"
  ]
}