Purpose
The API retrieves the activity logs of all the operations performed by admins in the Zoho Mail Admin Console.
Request URL
https://mail.zoho.com/api/organization/<zoid>/activity
Request Parameters
This method retrieves the Organization ID or the Org ID for the particular organization along with the other basic Organization details.
Parameter | Data Type | Permitted Values | Description |
zoid | Integer | - | The unique Zoho organization identifier number for the entire organization |
limit | Integer | Default value is 10 | The number of activities that should be retrieved |
searchKey | String | category For list of category values, refer here | These parameters and their respective values can be used to filter the results retrieved from the operation. Each of these values can be used together or even separately. |
subCategory For list of subcategory values, refer here | |||
performedOn The email address of the user on whom the operation was performed | |||
performedBy The email address of the admin who performed the operation | |||
operationType ADD UPDATE DELETE DOWNLOAD | |||
status success failure | |||
auditLogType ORGADMIN_AUDIT | |||
Example: When you enter multiple searchKeys, use the below format: category:<category value>::subCategory:<subcategory value> When you enter a single searchKey, use the below format: category:<category value> | |||
startTime* | Long | - | The time from when the search needs to be retrieved |
endTime* | Long | - | The time until when the activities need to be retrieved |
lastEntityId | String | - | The identifier used for the last entity that was returned in the previous retrieval that needs to be used for the upcoming iterations after the first one |
lastIndexTime | String | - | The identifier of the last time of the previous retrieval that needs to be used for the upcoming iterations after the first one |
byMode* | Boolean | True | - |
* - Mandatory parameter
Permitted category and subcategory values
Category Value | Subcategory Value |
organization | orgSettings |
organization | welcomeEmailTemplate |
organization | signatureTemplate |
organization | Locations |
organization | Customized login |
organization | orgUser |
domains | domainGeneral |
domains | domainConfiguration |
domains | Email configuration |
domains | Subdomain stripping |
domains | domainAlias |
domains | catch-all |
domains | notification |
domains | domainDisclaimer |
users | mailBox |
users | personalInformation |
users | emailAlias |
users | mailboxEmailForwarding |
users | mailboxActions |
users | outOfOffice |
users | signature |
users | anti-SpamSettings |
users | storage |
users | password |
users | two-factorAuthentication |
users | loginEmailAddress |
users | allowedIPAddresses |
users | MailBox-S/MIME |
users | sessionActivity |
users | emailPolicy |
users | customAdmin |
Groups | groupGeneral |
Groups | groupMembers |
Groups | groupMemberSettings |
Groups | antiSpamSettings |
Groups | moderation |
Groups | groupSettings |
Groups | emailRestrictions |
Groups | domainRestrictions |
Groups | groupAlias |
emailPolicy | emailPolicyGeneral |
emailPolicy | emailRestriction |
emailPolicy | accessRestriction |
emailPolicy | accountRestriction |
emailPolicy | emailForwardPolicy |
emailPolicy | orgAssociatedUsers |
emailPolicy | orgAssociatedGroups |
emailRestriction | emailRestrictionGeneral |
emailRestriction | domain |
emailRestriction | emailAddress |
emailRestriction | attachment |
emailRestriction | subject |
accountRestriction | accountRestrictionGeneral |
accountRestriction | externalAccountAccess |
accountRestriction | SignatureCustomisation |
accountRestriction | importEmail |
accountRestriction | exportEmail |
accountRestriction | attachFromCloud |
accountRestriction | addToCloud |
accountRestriction | displayBCC |
accessRestriction | accessRestrictionGeneral |
accessRestriction | POPAccess |
accessRestriction | IMAPAccess |
accessRestriction | activeSync |
accessRestriction | emailForwarding |
accessRestriction | POPAndIMAPSettings |
accessRestriction | emailForwardSettings |
accessRestriction | maximumSessionCount |
accessRestriction | mailClientIPRestriction |
accessRestriction | allowedIPAddresses |
emailForwardPolicy | emailForwardPolicyGeneral |
emailForwardPolicy | emailForwardingAddress |
spamVerification | SPFVerification |
spamVerification | DKIMVerification |
spamVerification | DMARCVerification |
spamVerification | DNSBLVerification |
spamVerification | whitelistUpdate |
spamVerification | blacklistUpdate |
spamVerification | quarantineUpdate |
emailRouting | configuration |
emailRouting | inboundGateway |
emailRouting | outboundGateway |
incomingRules | connectionFilter |
incomingRules | contentFilter |
incomingRules | emailForwarding |
outgoingRules | outgoingRulesgeneral |
bannersAndModifiers | calendarRoles |
bannersAndModifiers | branches |
security | TFA |
security | allowedIPAddresses |
security | passwordPolicy |
security | SAMLAuthentication |
security | suspiciousLogin |
security | S/MIME |
rolesAndPrivileges | roles |
rolesAndPrivileges | privileges |
spamProcessing | orgSpamProcessType |
spamProcessing | spamSender-basedAlerts |
spamProcessing | post-deliverySpamChecks |
spamProcessing | spamProcessingSettings |
trustedList | trustedEmails |
trustedList | trustedDomains |
trustedList | trustedIPAddresses |
allowedList | allowedEmails |
allowedList | allowedDomains |
blockedList | blockedEmails |
blockedList | blockedDomains |
blockedList | blockedIpAddress |
blockedList | blockedTLDs |
blockedList | recipientEmails |
blockedlistPatterns | senderPatterns |
blockedlistPatterns | subjectPatterns |
blockedlistPatterns | contentPatterns |
dataMigration | migrationServer |
dataMigration | migrationSettings |
dataMigration | Migration |
dataMigration | migrationUser |
importOrExport | importExportUsers |
importOrExport | importExportGroups |
importOrExport | importExportMailAccounts |
troubleshoot | blockAccount |
troubleshoot | retryMailDelete |
troubleshoot | unblockAccount |
troubleshoot | mailRecovery |
subscription | planSubscription |
subscription | subscriptionAddOn |
subscription | subscriptionPRVN |
internationalizedSpam | spamLanguage |
internationalizedSpam | spamCountry |
phishingAndMalware | cousinDomainVerification |
phishingAndMalware | displayNameSpoofing |
phishingAndMalware | malwareProcessing |
quarantine | quarantinedEmails |
quarantine | notificationSettings |
quarantine | selfModerators |
quarantine | deliveredEmails |
quarantine | deniedEmails |
compliance | dataSubjectRequest |
compliance | emailRecovery |
compliance | retryEmails |
otherApps | contacts |
otherApps | cliq |
integrationsAndExtensions | extensions |
integrationsAndExtensions | orgApps |
integrationsAndExtensions | marketplaceApps |
integrationsAndExtensions | purchasedApps |
MDM | mdmSettings |
MDM | mdmIntegration |
integrationsAndDeveloperPlatform | developerRoles |
integrationsAndDeveloperPlatform | marketplaceWhitelists |
integrationsAndDeveloperPlatform | extensions |
people | peopleUser |
imports | usersImport |
imports | groupsImport |
imports | policiesImport |
imports | mailAccountsImport |
exports | usersExport |
exports | groupExport |
exports | policiesExport |
exports | mailAccountsExport |
exports | quarantineEmailsExport |
exports | exportMailFromFolders |
calendar | calendarRoles |
calendar | branches |
calendar | resources |
calendar | features |
calendar | bookings |
calendar | reports |
calendar | calendarSettings |
calendar | interoperabilitySettings |
Response Codes
Please refer Response Codes.
Sample Response
Copied