Returns a complete list of users—both active and inactive—for a specific CRM instance. To pull users across all branches, run the query from the main corporate instance. This report is commonly used to audit user access, track deactivations, and review licensing details across the organization.
Note: This is a complete user list. If you only want to report on active users, you’ll need to filter out entries where status is “Inactive”.
https://secure-api.setshape.com/api/reports/branch-retired-users/{crm_id}
Send the following parameters in the request body under the filters object:
slctPerPage
pn
Number
Number
Number of records per page
Page number (for pagination)
{
“filters”: {
“slctPerPage”: 3,
“pn”: 1
}
}
{
“status”: 1,
“msg”: “success”,
“data”: [
{
“id”: 1063,
“firstname”: “Aaliyah”,
“userName”: “Aaliyah Davis”,
“teamBranch”: null,
“companyId”: 19128,
“teamBranchCode”: null,
“name”: “AnnieMac Home Mortgage”,
“status”: “Inactive”,
“role”: “Manager”,
“departmentName”: “Loan Partner”,
“profileTitle”: “”,
“email”: “OLD1abdavis+annie-mac.com@dasine.com”,
“phone”: “(469) 613-2295”,
“created_at”: “01/15/2024 08:24 PM”,
“deactivationDate”: “01/15/2024 08:35 PM”,
“modifiedDate”: “01/15/2024 12:34 AM”,
“loginat”: null,
“division”: null,
“licenseNumber”: null,
“userLicenseCost”: “99”
},
{
“id”: 1069,
“firstname”: “Aaliyah”,
“userName”: “Aaliyah Davis”,
“teamBranch”: “Consumer Direct Texas”,
“teamBranchCode”: “2024”,
“name”: “AnnieMac Home Mortgage”,
“city”: “Plano”,
“profilestate”: “TX”,
“zip”: “75024”,
“status”: “Inactive”,
“role”: “Manager”,
“departmentName”: “Loan Partner”,
“profileTitle”: “Loan Partner II”,
“email”: “abdavis@annie-mac.com”,
“phone”: “(469) 613-2295”,
“created_at”: “01/15/2024 08:24 PM”,
“deactivationDate”: “03/25/2024 09:32 AM”,
“modifiedDate”: “03/21/2024 12:06 PM”,
“loginat”: “03/21/2024 05:06 PM”,
“division”: “Consumer Direct”,
“licenseNumber”: “”,
“userLicenseCost”: “99”
}
]
}
id
userName
status
role
departmentName
division
teamBranch
teamBranchCode
email
phone
created_at
modifiedDate
deactivationDate
loginat
userLicenseCost
Internal user ID
Full user display name
User’s status (e.g. Active, Inactive)
User's assigned role (e.g. LO, Manager)
Department (e.g. Loan Partner, Sales)
Optional division name
Assigned team/branch (if applicable)
Branch code (used in routing/filtering)
User’s email address
Phone number
Date the user account was created
Last modified timestamp on user record
Date the user was deactivated (if applicable)
Last login time (if known)
Monthly license cost associated with this user (if tracked)
If you’re building reports on active users only, filter by:
“status”: “Active”
To isolate retired/inactive users, filter where:
“status”: “Inactive”
Changing templates will take time and may require a template change fee.
Not sure what to choose? Contact us.