Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1424096195.5 KB
Groups

Retrieve Groups

Returns a list of all Groups

get/v3/groups

Query parameters

tqlstring

TQL query string for filtering response list

fieldsstring[]

Group subentity fields to include in response (See OPTIONS endpoint for valid values)

countstring

Boolean that detnotes whether counts should be returned in the resultset

sortingstring

Sorting order for resultset

Response

The Groups

idinteger
dateAddedstring date-time
ownerIdinteger
ownerNamestring
webLinkstring
typestring required
xidstring
namestring required
upVoteboolean
upVoteCountstring
downVoteCountstring
generatedReportboolean
externalDateAddedstring date-time
externalLastModifiedstring date-time
externalDateExpiresstring date-time
fileNamestring
fileSizeinteger
statusstring
malwareboolean
passwordstring
documentTypestring
documentDateAddedstring date-time
tostring
fromstring
subjectstring
scoreinteger
headerstring
bodystring
scoreIncludesBodyboolean
emailDatestring date-time
scoreBreakdownstring
eventTypestring
fileTypestring
fileTextstring
signatureDateAddedstring date-time
escalatedboolean
remindedboolean
overdueboolean
dueDatestring date-time
reminderDatestring date-time
escalationDatestring date-time
lastModifiedstring date-time
legacyLinkstring
firstSeenstring date-time
lastSeenstring date-time
eventDatestring date-time
publishDatestring date-time