latestOpenAPI 3.0.02026-08-12207455917.9 KB
bad0d2db9b7a
Offices
Get office
Gets office details for the specified office GUID when the current user has access to that office.
Validation & Requirements
Required Parameters
- officeGuid (path, string, format=guid)
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/offices/{officeGuid}
Path parameters
officeGuidstring guid required
GUID of the office to retrieve.
Query parameters
includeDeactivatedboolean
Include deactivated offices. Defaults to false.