Clients

Gets Client by Owner Id

get
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Query parameters
ownerIdstring · uuidOptional
searchTextstringOptional
$filterstringOptional

Filter results. See OData documentation https://www.odata.org/getting-started/basic-tutorial/#filter

$selectstringOptional

Request a limited set of properties. See OData documentation https://www.odata.org/getting-started/basic-tutorial/#select

$orderbystringOptional

Sort results. See OData documentation https://www.odata.org/getting-started/basic-tutorial/#orderby

$skipintegerOptional

The number of results to skip. See OData documentation https://www.odata.org/getting-started/basic-tutorial/#topskip

$topintegerOptional

The number of results to return. Defaults to 50. See OData documentation https://www.odata.org/getting-started/basic-tutorial/#topskip

Responses
200

Success

get
/clients
GET /homedashboard/clients HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

[
  {
    "externalId": "text",
    "source": "text",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000",
    "referredById": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "homePhone": "text",
    "workPhone": "text",
    "mobilePhone": "text",
    "fax": "text",
    "contactAddress": {
      "addressLine1": "text",
      "addressLine2": "text",
      "city": "text",
      "state": "FL",
      "zipCode": "text"
    },
    "isSilenced": true,
    "isArchived": true,
    "createdOn": "2025-12-06T04:40:03.584Z",
    "updatedOn": "2025-12-06T04:40:03.584Z",
    "fico": 1,
    "totalIncome": 1,
    "totalDebtPayments": 1,
    "firstTimeBuyer": true,
    "loginToken": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "text",
    "lastName": "text"
  }
]

Creates a Client

post
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Body
externalIdstring | nullableOptional
sourcestring | nullableOptional
ownerIdstring · uuid | nullableOptional
referredByIdstring · uuid | nullableOptional
emailstring · min: 1RequiredExample: [email protected]Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
homePhonestring | nullableOptional
workPhonestring | nullableOptional
mobilePhonestring | nullableOptional
faxstring | nullableOptional
isSilencedbooleanOptional
isArchivedbooleanOptional
createdOnstring · date-timeRead-onlyOptional
updatedOnstring · date-time | nullableRead-onlyOptional
ficointeger · int32 | nullableOptional
totalIncomenumber · double | nullableOptional
totalDebtPaymentsnumber · double | nullableOptional
firstTimeBuyerboolean | nullableOptional
loginTokenstring | nullableOptional
idstring · uuidRead-onlyOptional
firstNamestring · min: 1Required
lastNamestring · min: 1Required
Responses
200

Success

post
/clients
POST /homedashboard/clients HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json;odata.metadata=minimal;odata.streaming=true
Accept: */*
Content-Length: 511

{
  "externalId": "text",
  "source": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "referredById": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "homePhone": "text",
  "workPhone": "text",
  "mobilePhone": "text",
  "fax": "text",
  "contactAddress": {
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "state": "FL",
    "zipCode": "text"
  },
  "isSilenced": true,
  "isArchived": true,
  "fico": 1,
  "totalIncome": 1,
  "totalDebtPayments": 1,
  "firstTimeBuyer": true,
  "loginToken": "text",
  "firstName": "text",
  "lastName": "text"
}
200

Success

{
  "id": "text",
  "type": "text",
  "createdTimestamp": "2025-12-06T04:40:03.584Z",
  "updatedTimestamp": "2025-12-06T04:40:03.584Z"
}

Delete all Clients

delete
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Responses
delete
/clients
DELETE /homedashboard/clients HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
405

Operation is not currently supported on this resource

No content

Gets Client by Id

get
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters
idstring · uuidRequired

GUID of client to read

Responses
200

Client with Id found

get
/clients/{id}
GET /homedashboard/clients/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "externalId": "text",
  "source": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "referredById": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "homePhone": "text",
  "workPhone": "text",
  "mobilePhone": "text",
  "fax": "text",
  "contactAddress": {
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "state": "FL",
    "zipCode": "text"
  },
  "isSilenced": true,
  "isArchived": true,
  "createdOn": "2025-12-06T04:40:03.584Z",
  "updatedOn": "2025-12-06T04:40:03.584Z",
  "fico": 1,
  "totalIncome": 1,
  "totalDebtPayments": 1,
  "firstTimeBuyer": true,
  "loginToken": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text"
}

Replaces a Client

put
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters
idstring · uuidRequired
Body
externalIdstring | nullableOptional
sourcestring | nullableOptional
ownerIdstring · uuid | nullableOptional
referredByIdstring · uuid | nullableOptional
emailstring · min: 1RequiredExample: [email protected]Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
homePhonestring | nullableOptional
workPhonestring | nullableOptional
mobilePhonestring | nullableOptional
faxstring | nullableOptional
isSilencedbooleanOptional
isArchivedbooleanOptional
createdOnstring · date-timeRead-onlyOptional
updatedOnstring · date-time | nullableRead-onlyOptional
ficointeger · int32 | nullableOptional
totalIncomenumber · double | nullableOptional
totalDebtPaymentsnumber · double | nullableOptional
firstTimeBuyerboolean | nullableOptional
loginTokenstring | nullableOptional
idstring · uuidRead-onlyOptional
firstNamestring · min: 1Required
lastNamestring · min: 1Required
Responses
200

Success

put
/clients/{id}
PUT /homedashboard/clients/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json;odata.metadata=minimal;odata.streaming=true
Accept: */*
Content-Length: 511

{
  "externalId": "text",
  "source": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "referredById": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "homePhone": "text",
  "workPhone": "text",
  "mobilePhone": "text",
  "fax": "text",
  "contactAddress": {
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "state": "FL",
    "zipCode": "text"
  },
  "isSilenced": true,
  "isArchived": true,
  "fico": 1,
  "totalIncome": 1,
  "totalDebtPayments": 1,
  "firstTimeBuyer": true,
  "loginToken": "text",
  "firstName": "text",
  "lastName": "text"
}
200

Success

{
  "id": "text",
  "type": "text",
  "createdTimestamp": "2025-12-06T04:40:03.584Z",
  "updatedTimestamp": "2025-12-06T04:40:03.584Z"
}

Deletes Client by Id

delete
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters
idstring · uuidRequired

Client GUID

Responses
delete
/clients/{id}
DELETE /homedashboard/clients/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Updates a Client

patch
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters
idstring · uuidRequired
Body
externalIdstring | nullableOptional
sourcestring | nullableOptional
ownerIdstring · uuid | nullableOptional
referredByIdstring · uuid | nullableOptional
emailstring · min: 1RequiredExample: [email protected]Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
homePhonestring | nullableOptional
workPhonestring | nullableOptional
mobilePhonestring | nullableOptional
faxstring | nullableOptional
isSilencedbooleanOptional
isArchivedbooleanOptional
createdOnstring · date-timeRead-onlyOptional
updatedOnstring · date-time | nullableRead-onlyOptional
ficointeger · int32 | nullableOptional
totalIncomenumber · double | nullableOptional
totalDebtPaymentsnumber · double | nullableOptional
firstTimeBuyerboolean | nullableOptional
loginTokenstring | nullableOptional
idstring · uuidRead-onlyOptional
firstNamestring · min: 1Required
lastNamestring · min: 1Required
Responses
200

Success

patch
/clients/{id}
PATCH /homedashboard/clients/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json;odata.metadata=minimal;odata.streaming=true
Accept: */*
Content-Length: 511

{
  "externalId": "text",
  "source": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "referredById": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "homePhone": "text",
  "workPhone": "text",
  "mobilePhone": "text",
  "fax": "text",
  "contactAddress": {
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "state": "FL",
    "zipCode": "text"
  },
  "isSilenced": true,
  "isArchived": true,
  "fico": 1,
  "totalIncome": 1,
  "totalDebtPayments": 1,
  "firstTimeBuyer": true,
  "loginToken": "text",
  "firstName": "text",
  "lastName": "text"
}
200

Success

{
  "id": "text",
  "type": "text",
  "createdTimestamp": "2025-12-06T04:40:03.584Z",
  "updatedTimestamp": "2025-12-06T04:40:03.584Z"
}
PreviousAuthNextLoan Applications

Last updated