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

post

/v1/clients

Header parameters

x-api-keystring

Body

idstring

fullNamestringrequired

countryCodestringrequired

phonestringrequired

emailstring

registrationDatestring

dobstring

addressstring

notesstring

referralSourcestring

photoUrlstring · uri

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

contactTypestring · enum

Options: HOME, MOBILE, WORK

addressTypestring · enum

Options: HOME, WORK

genderstring · enum

Options: Male, Female, Unknown, Other

maritalStatusstring · enum

Options: UNMARRIED, MARRIED, OTHER

customFieldsobject

tagsstring[]

primaryLocationobject

primaryStaffobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<YOUR HOST>/v1/clients' \
  --header 'Content-Type: application/json' \
  --data '{"fullName":"text","countryCode":"text","phone":"text","contactType":"HOME","addressType":"HOME","gender":"Male","maritalStatus":"UNMARRIED","customFields":{},"tags":[null],"primaryLocation":{"id":"text"},"primaryStaff":{"id":"text"}}'

200

200

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

200 response

Search clients based on parameters

get

/v1/clients

Query parameters

limitstring

primaryLocationIdstring

tagsstring

endDatestring

pagestring

startDatestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/clients' \
  --header 'x-api-key: text'

200

200

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

200 response

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

E.g. 5tw9zcQkbu

Gets a Client by Id

get

/v1/clients/{clientId}

Path parameters

clientIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/clients/{clientId}' \
  --header 'x-api-key: text'

200

200

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

200 response

Updates a particular client

put

/v1/clients/{clientId}

Path parameters

clientIdstringrequired

Header parameters

x-api-keystringrequired

Body

idstring

fullNamestringrequired

countryCodestringrequired

phonestringrequired

emailstring

registrationDatestring

dobstring

addressstring

notesstring

referralSourcestring

photoUrlstring · uri

emergencyRelationTypestring

emergencyNamestring

emergencyCountryCodestring

identificationNumberstring

emergencyPhonestring

contactTypestring · enum

Options: HOME, MOBILE, WORK

addressTypestring · enum

Options: HOME, WORK

genderstring · enum

Options: Male, Female, Unknown, Other

maritalStatusstring · enum

Options: UNMARRIED, MARRIED, OTHER

customFieldsobject

tagsstring[]

primaryLocationobject

primaryStaffobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://<YOUR HOST>/v1/clients/{clientId}' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"fullName":"text","countryCode":"text","phone":"text","contactType":"HOME","addressType":"HOME","gender":"Male","maritalStatus":"UNMARRIED","customFields":{},"tags":[null],"primaryLocation":{"id":"text"},"primaryStaff":{"id":"text"}}'

200

200

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

200 response

Deletes a client based on clientId

delete

/v1/clients/{clientId}

Path parameters

clientIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://<YOUR HOST>/v1/clients/{clientId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response

post

/v1/clients/{clientId}/tags/add

Path parameters

clientIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<YOUR HOST>/v1/clients/{clientId}/tags/add' \
  --header 'x-api-key: text'

200

200

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

200 response

post

/v1/clients/{clientId}/tags/remove

Path parameters

clientIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<YOUR HOST>/v1/clients/{clientId}/tags/remove' \
  --header 'x-api-key: text'

200

200

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

200 response