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.

post

Creates a new client based on parameters

Header parameters

x-api-keystringOptional

Body

idstringOptional

fullNamestringRequired

contactTypestring · enumOptionalPossible values:

countryCodestringRequired

phonestringRequired

emailstringOptional

registrationDatestringOptional

dobstringOptional

addressTypestring · enumOptionalPossible values:

addressstringOptional

genderstring · enumOptionalPossible values:

maritalStatusstring · enumOptionalPossible values:

tagsstring[]Optional

notesstringOptional

referralSourcestringOptional

customFieldsobjectOptional

photoUrlstring · uriOptional

emergencyRelationTypestringOptional

emergencyNamestringOptional

emergencyCountryCodestringOptional

identificationNumberstringOptional

emergencyPhonestringOptional

Responses

200

200 response

application/json

post

POST /v1/clients HTTP/1.1
Host: <YOUR HOST>
Content-Type: application/json
Accept: */*
Content-Length: 544

{
  "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": {},
  "photoUrl": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}

200

200 response

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

get

Query parameters

limitstringOptional

primaryLocationIdstringOptional

tagsstringOptional

endDatestringOptional

pagestringOptional

startDatestringOptional

searchTextstringOptional

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

get

GET /v1/clients HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

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

get

Gets a Client by Id

Path parameters

clientIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

get

GET /v1/clients/{clientId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

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

put

Updates a particular client

Path parameters

clientIdstringRequired

Header parameters

x-api-keystringRequired

Body

idstringOptional

fullNamestringRequired

contactTypestring · enumOptionalPossible values:

countryCodestringRequired

phonestringRequired

emailstringOptional

registrationDatestringOptional

dobstringOptional

addressTypestring · enumOptionalPossible values:

addressstringOptional

genderstring · enumOptionalPossible values:

maritalStatusstring · enumOptionalPossible values:

tagsstring[]Optional

notesstringOptional

referralSourcestringOptional

customFieldsobjectOptional

photoUrlstring · uriOptional

emergencyRelationTypestringOptional

emergencyNamestringOptional

emergencyCountryCodestringOptional

identificationNumberstringOptional

emergencyPhonestringOptional

Responses

200

200 response

application/json

put

PUT /v1/clients/{clientId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 544

{
  "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": {},
  "photoUrl": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}

200

200 response

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

delete

Deletes a client based on clientId

Path parameters

clientIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

delete

DELETE /v1/clients/{clientId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

{
  "success": true
}

post

Path parameters

clientIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

post

POST /v1/clients/{clientId}/tags/add HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

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

post

Path parameters

clientIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

post

POST /v1/clients/{clientId}/tags/remove HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

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

PreviousClient Tags NextContact Tags

Last updated 8 months ago