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}

Request

  • Base URL
    https://api.skyslope.com
  • URL
    https://api.skyslope.com/api/offices/{officeGuid}
  • Auth
    OpenID Connect (https://example.com/.well-known/openid-configuration)

Path parameters

officeGuidstring guid required

GUID of the office to retrieve.

Query parameters

includeDeactivatedboolean

Include deactivated offices. Defaults to false.

Response

warningsstring[] nullable

Changes

No recorded changes to this operation across all 6 revisions of this API.