Users

Get Users

get
Authorizations
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

get
/users
GET /homedashboard/users HTTP/1.1
Host: 
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": "2025-12-06T04:42:05.115Z",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "hasRegistered": true,
    "lastLoginOn": "2025-12-06T04:42:05.115Z",
    "createdOn": "2025-12-06T04:42:05.115Z",
    "updatedOn": "2025-12-06T04:42:05.115Z"
  }
]

Create a User

post
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Query parameters
sendInvitebooleanOptional

If true, sends the invite email after creation

Default: false
Body
idstring · uuidRead-onlyOptional
firstNamestring · max: 64Required
lastNamestring · max: 64Required
jobTitlestring | nullableOptional
profileImageUrlstring | nullableOptional
externalIdstring | nullableOptional
sourcestring | nullableOptional
emailstring · email · max: 1024Required
nmlsIdstring | nullableOptional
addressLine1string | nullableOptional
addressLine2string | nullableOptional
citystring | nullableOptional
statestring | nullableOptional
zipCodestring | nullableOptional
workPhonestring | nullableOptional
mobilePhonestring | nullableOptional
faxstring | 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

post
/users
POST /homedashboard/users HTTP/1.1
Host: 
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": "2025-12-06T04:42:05.115Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}
200

Success

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

Get a User

get
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters
idstring · uuidRequired
Responses
200

User with Id found

get
/users/{id}
GET /homedashboard/users/{id} HTTP/1.1
Host: 
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": "2025-12-06T04:42:05.115Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "hasRegistered": true,
  "lastLoginOn": "2025-12-06T04:42:05.115Z",
  "createdOn": "2025-12-06T04:42:05.115Z",
  "updatedOn": "2025-12-06T04:42:05.115Z"
}

Delete a User

delete
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters
idstring · uuidRequired
Responses
delete
/users/{id}
DELETE /homedashboard/users/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a User

patch
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters
idstring · uuidRequired
Body
idstring · uuidRead-onlyOptional
firstNamestring · max: 64Required
lastNamestring · max: 64Required
jobTitlestring | nullableOptional
profileImageUrlstring | nullableOptional
externalIdstring | nullableOptional
sourcestring | nullableOptional
emailstring · email · max: 1024Required
nmlsIdstring | nullableOptional
addressLine1string | nullableOptional
addressLine2string | nullableOptional
citystring | nullableOptional
statestring | nullableOptional
zipCodestring | nullableOptional
workPhonestring | nullableOptional
mobilePhonestring | nullableOptional
faxstring | 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

patch
/users/{id}
PATCH /homedashboard/users/{id} HTTP/1.1
Host: 
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": "2025-12-06T04:42:05.115Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "id": "text",
  "type": "text",
  "createdTimestamp": "2025-12-06T04:42:05.115Z",
  "updatedTimestamp": "2025-12-06T04:42:05.115Z"
}
PreviousTypesNextWebhooks

Last updated