THthreatconnect
Groups

Retrieve Group by ID

Changed on

Returns a single Group corresponding to provided uniqueId

get/v3/groups/{uniqueId}

Request

  • Base URL
    https://app.threatconnect.com/api
  • URL
    https://app.threatconnect.com/api/v3/groups/{uniqueId}
  • Auth
    API key in header Authorization

Path parameters

uniqueId'1' | '2' | '3' required

param ID of the Group that needs to be fetched

ID of the Group to be fetched

Query parameters

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

Response

The Group

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
aiProviderstring
aiLastRetrievalDatestring date-time
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

Changes

  • 726ab3792601Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property /// to the response with the status