Sales
Get audit logs for a sale
Validation & Requirements
Required Parameters
- saleGuid (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/files/sales/{saleGuid}/auditLogs
Request
- Base URLhttps://api.skyslope.com
- URLhttps://api.skyslope.com/api/files/sales/{saleGuid}/auditLogs
- AuthOpenID Connect (https://example.com/.well-known/openid-configuration)
Path parameters
saleGuidstring guid required
GUID of the sale to retrieve audit logs for. Format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Query parameters
startDatestring date-time nullable
Filter audit logs from this date (inclusive). Format: ISO 8601 (e.g., '2024-01-15T00:00:00Z') If not specified, returns all historical logs
endDatestring date-time nullable
Filter audit logs to this date (inclusive). Format: ISO 8601 (e.g., '2024-01-31T23:59:59Z') Must be after startDate if both are specified
includeEmailCommunicationboolean
Include email sender/recipient details for email-type audit logs (EmailOut, EmailReceived, Fax). When true, email-related audit logs will include:
- To: Recipient email address(es)
- User: Sender's email address (for email types) Default: false (email communication details are not included)
Response
Changes
No recorded changes to this operation across all 6 revisions of this API.