latestOpenAPI 3.0.02026-08-12207455917.9 KB
bad0d2db9b7a
Users
List users
Lists users for the subscriber with optional filters. includeDeactivated controls whether inactive users are included. officeGuid can be a comma-separated GUID list (use 00000000-0000-0000-0000-000000000000 for the ALL office). email filter is trimmed before query execution.
Validation & Requirements
Required Parameters
- None
Required JSON Body Fields
- None
Validations
- Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
- Invalid date values in *date* fields return 422 Unprocessable Entity.
- Missing required request body returns 422 Unprocessable Entity with Missing request body..
- Additional business-rule validation may return 422 with details in the errors array.
get/api/users
Query parameters
includeDeactivatedboolean
Include deactivated users. Defaults to false.
officeGuidstring nullable
Only return users who have access to any office in this comma separated list of offices. Use an empty guid (00000000-0000-0000-0000-000000000000) for the ALL office.
emailstring nullable
Filter users by email address with intelligent matching:
Active Users: Exact match only
- Input: "john.doe@company.com"
- Matches: "john.doe@company.com"
Deactivated Users: Wildcard match for suffixed emails
- Input: "john.doe@company.com"
- Matches: "john.doe@company.com_deleted", "john.doe@company.com_deactivated"
Important Notes:
- Whitespace is automatically trimmed from input
- Deactivated users are only returned when includeDeactivated=true
- Case sensitivity depends on database collation (typically case-insensitive)
- Empty or null values disable email filtering (returns all users)
Examples:
- Find active user: ?email=agent@skyslope.com
- Find both active and deactivated: ?email=agent@skyslope.com&includeDeactivated=true
- Combine with office filter: ?email=broker@skyslope.com&officeGuid=12345678-1234-1234-1234-123456789012