Users

Get Users

get

Authorizations

Bearer

AuthorizationstringRequired

Enter JWT Bearer token only

Query parameters

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

Users found

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

idstring · uuidRead-onlyOptional

firstNamestring · max: 64Required

lastNamestring · max: 64Required

jobTitlestring · max: 512 · nullableOptional

profileImageUrlstring · nullableOptional

externalIdstring · max: 512 · nullableOptional

sourcestring · nullableOptional

emailstring · email · max: 1024Required

nmlsIdstring · max: 64 · nullableOptional

addressLine1string · max: 512 · nullableOptional

addressLine2string · max: 512 · nullableOptional

citystring · max: 256 · nullableOptional

statestring · max: 32 · nullableOptional

zipCodestring · max: 32 · nullableOptional

workPhonestring · max: 64 · nullableOptional

mobilePhonestring · max: 64 · nullableOptional

faxstring · max: 64 · nullableOptional

websitestring · nullableOptional

rolesstring[] · nullableOptional

enrollmentDatestring · date-time · nullableOptional

organizationIdstring · uuidRequired

hasRegisteredbooleanRead-onlyOptional

lastLoginOnstring · date-time · nullableRead-onlyOptional

createdOnstring · date-time · nullableRead-onlyOptional

updatedOnstring · date-time · nullableRead-onlyOptional

403

Unauthorized

500

Server Error

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

get

/users

HTTPcURLJavaScriptPython

GET /homedashboard/users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "text",
    "lastName": "text",
    "jobTitle": "text",
    "profileImageUrl": "text",
    "externalId": "text",
    "source": "text",
    "email": "[email protected]",
    "nmlsId": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "state": "text",
    "zipCode": "text",
    "workPhone": "text",
    "mobilePhone": "text",
    "fax": "text",
    "website": "text",
    "roles": [
      "text"
    ],
    "enrollmentDate": "2026-03-11T12:20:00.068Z",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "hasRegistered": true,
    "lastLoginOn": "2026-03-11T12:20:00.068Z",
    "createdOn": "2026-03-11T12:20:00.068Z",
    "updatedOn": "2026-03-11T12:20:00.068Z"
  }
]

Create a User

post

Authorizations

Bearer

AuthorizationstringRequired

Enter JWT Bearer token only

Query parameters

sendInvitebooleanOptional

If true, sends the invite email after creation

Default: false

Body

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/json-patch+jsontext/jsonapplication/*+json

idstring · uuidRead-onlyOptional

firstNamestring · max: 64Required

lastNamestring · max: 64Required

jobTitlestring · max: 512 · nullableOptional

profileImageUrlstring · nullableOptional

externalIdstring · max: 512 · nullableOptional

sourcestring · nullableOptional

emailstring · email · max: 1024Required

nmlsIdstring · max: 64 · nullableOptional

addressLine1string · max: 512 · nullableOptional

addressLine2string · max: 512 · nullableOptional

citystring · max: 256 · nullableOptional

statestring · max: 32 · nullableOptional

zipCodestring · max: 32 · nullableOptional

workPhonestring · max: 64 · nullableOptional

mobilePhonestring · max: 64 · nullableOptional

faxstring · max: 64 · nullableOptional

websitestring · nullableOptional

rolesstring[] · nullableOptional

enrollmentDatestring · date-time · nullableOptional

organizationIdstring · uuidRequired

hasRegisteredbooleanRead-onlyOptional

lastLoginOnstring · date-time · nullableRead-onlyOptional

createdOnstring · date-time · nullableRead-onlyOptional

updatedOnstring · date-time · nullableRead-onlyOptional

Responses

200

Success

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

Represents an audit record for an entity that has been created or updated.

idstring · nullableOptional

The unique identifier of the entity that was modified.

typestring · nullableOptional

A string indicating the type or category of the modified entity (e.g., “Webhook”, “LoanApplicationTask”).

createdTimestampstring · date-time · nullableOptional

The timestamp when the entity was first created.

updatedTimestampstring · date-time · nullableOptional

The timestamp when the entity was last updated.

post

/users

HTTPcURLJavaScriptPython

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

{
  "firstName": "text",
  "lastName": "text",
  "jobTitle": "text",
  "profileImageUrl": "text",
  "externalId": "text",
  "source": "text",
  "email": "[email protected]",
  "nmlsId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "city": "text",
  "state": "text",
  "zipCode": "text",
  "workPhone": "text",
  "mobilePhone": "text",
  "fax": "text",
  "website": "text",
  "roles": [
    "text"
  ],
  "enrollmentDate": "2026-03-11T12:20:00.068Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/json-patch+jsontext/jsonapplication/*+json

200

Success

{
  "id": "text",
  "type": "text",
  "createdTimestamp": "2026-03-11T12:20:00.068Z",
  "updatedTimestamp": "2026-03-11T12:20:00.068Z"
}

Get a User

get

Authorizations

Bearer

AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters

idstring · uuidRequired

Responses

200

User with Id found

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

idstring · uuidRead-onlyOptional

firstNamestring · max: 64Required

lastNamestring · max: 64Required

jobTitlestring · max: 512 · nullableOptional

profileImageUrlstring · nullableOptional

externalIdstring · max: 512 · nullableOptional

sourcestring · nullableOptional

emailstring · email · max: 1024Required

nmlsIdstring · max: 64 · nullableOptional

addressLine1string · max: 512 · nullableOptional

addressLine2string · max: 512 · nullableOptional

citystring · max: 256 · nullableOptional

statestring · max: 32 · nullableOptional

zipCodestring · max: 32 · nullableOptional

workPhonestring · max: 64 · nullableOptional

mobilePhonestring · max: 64 · nullableOptional

faxstring · max: 64 · nullableOptional

websitestring · nullableOptional

rolesstring[] · nullableOptional

enrollmentDatestring · date-time · nullableOptional

organizationIdstring · uuidRequired

hasRegisteredbooleanRead-onlyOptional

lastLoginOnstring · date-time · nullableRead-onlyOptional

createdOnstring · date-time · nullableRead-onlyOptional

updatedOnstring · date-time · nullableRead-onlyOptional

400

Invalid identifier

403

Unauthorized

404

User not found

500

Server Error

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

get

/users/{id}

HTTPcURLJavaScriptPython

GET /homedashboard/users/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "jobTitle": "text",
  "profileImageUrl": "text",
  "externalId": "text",
  "source": "text",
  "email": "[email protected]",
  "nmlsId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "city": "text",
  "state": "text",
  "zipCode": "text",
  "workPhone": "text",
  "mobilePhone": "text",
  "fax": "text",
  "website": "text",
  "roles": [
    "text"
  ],
  "enrollmentDate": "2026-03-11T12:20:00.068Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "hasRegistered": true,
  "lastLoginOn": "2026-03-11T12:20:00.068Z",
  "createdOn": "2026-03-11T12:20:00.068Z",
  "updatedOn": "2026-03-11T12:20:00.068Z"
}

Delete a User

delete

Authorizations

Bearer

AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters

idstring · uuidRequired

Responses

204

User deleted successfully

400

Invalid identifier

403

Unauthorized

404

User not found

500

Server Error

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

delete

/users/{id}

HTTPcURLJavaScriptPython

DELETE /homedashboard/users/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a User

patch

Authorizations

Bearer

AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters

idstring · uuidRequired

Body

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/json-patch+jsontext/jsonapplication/*+json

idstring · uuidRead-onlyOptional

firstNamestring · max: 64Required

lastNamestring · max: 64Required

jobTitlestring · max: 512 · nullableOptional

profileImageUrlstring · nullableOptional

externalIdstring · max: 512 · nullableOptional

sourcestring · nullableOptional

emailstring · email · max: 1024Required

nmlsIdstring · max: 64 · nullableOptional

addressLine1string · max: 512 · nullableOptional

addressLine2string · max: 512 · nullableOptional

citystring · max: 256 · nullableOptional

statestring · max: 32 · nullableOptional

zipCodestring · max: 32 · nullableOptional

workPhonestring · max: 64 · nullableOptional

mobilePhonestring · max: 64 · nullableOptional

faxstring · max: 64 · nullableOptional

websitestring · nullableOptional

rolesstring[] · nullableOptional

enrollmentDatestring · date-time · nullableOptional

organizationIdstring · uuidRequired

hasRegisteredbooleanRead-onlyOptional

lastLoginOnstring · date-time · nullableRead-onlyOptional

createdOnstring · date-time · nullableRead-onlyOptional

updatedOnstring · date-time · nullableRead-onlyOptional

Responses

200

User updated successfully

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

Represents an audit record for an entity that has been created or updated.

idstring · nullableOptional

The unique identifier of the entity that was modified.

typestring · nullableOptional

A string indicating the type or category of the modified entity (e.g., “Webhook”, “LoanApplicationTask”).

createdTimestampstring · date-time · nullableOptional

The timestamp when the entity was first created.

updatedTimestampstring · date-time · nullableOptional

The timestamp when the entity was last updated.

400

Bad Request

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

403

Unauthorized

404

User not found

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

500

Server Error

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/octet-streamtext/json

patch

/users/{id}

HTTPcURLJavaScriptPython

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

{
  "firstName": "text",
  "lastName": "text",
  "jobTitle": "text",
  "profileImageUrl": "text",
  "externalId": "text",
  "source": "text",
  "email": "[email protected]",
  "nmlsId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "city": "text",
  "state": "text",
  "zipCode": "text",
  "workPhone": "text",
  "mobilePhone": "text",
  "fax": "text",
  "website": "text",
  "roles": [
    "text"
  ],
  "enrollmentDate": "2026-03-11T12:20:00.068Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}

application/json;odata.metadata=minimal;odata.streaming=trueapplication/json;odata.metadata=minimal;odata.streaming=falseapplication/json;odata.metadata=minimalapplication/json;odata.metadata=full;odata.streaming=trueapplication/json;odata.metadata=full;odata.streaming=falseapplication/json;odata.metadata=fullapplication/json;odata.metadata=none;odata.streaming=trueapplication/json;odata.metadata=none;odata.streaming=falseapplication/json;odata.metadata=noneapplication/json;odata.streaming=trueapplication/json;odata.streaming=falseapplication/jsonapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=minimal;IEEE754Compatible=falseapplication/json;odata.metadata=minimal;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=full;IEEE754Compatible=falseapplication/json;odata.metadata=full;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=trueapplication/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=falseapplication/json;odata.metadata=none;IEEE754Compatible=trueapplication/json;odata.streaming=true;IEEE754Compatible=falseapplication/json;odata.streaming=true;IEEE754Compatible=trueapplication/json;odata.streaming=false;IEEE754Compatible=falseapplication/json;odata.streaming=false;IEEE754Compatible=trueapplication/json;IEEE754Compatible=falseapplication/json;IEEE754Compatible=trueapplication/xmltext/plainapplication/json-patch+jsontext/jsonapplication/*+json

{
  "id": "text",
  "type": "text",
  "createdTimestamp": "2026-03-11T12:20:00.068Z",
  "updatedTimestamp": "2026-03-11T12:20:00.068Z"
}