Classic APIs
ClassicGroupsApi
groupAuditLogs

groupAuditLogs

Gets audit log entries for a group.

Parameters

NameTypeDescription
groupIdIdentifierThe id of the group.
actionType?GroupAuditLogActionTypeThe action to filter the audit logs by. (no filter will be applied if actionType is undefined).
userId?IdentifierFilter for specific user by their id.
limit?10 | 25 | 50 | 100The number of results to be returned.
sortOrder?SortOrderThe order that the results are sorted in.
cursor?stringThe paging cursor for the previous or next page.

Example

const { data: auditLog } = await ClassicGroupsApi.groupAuditLogs({ groupId: 5850082 }); 

Example Data

{
  previousPageCursor: null,
  nextPageCursor: null,
  data: [
    {
      actor: {
        user: {
          hasVerifiedBadge: false,
          userId: 45348281,
          username: "MightyPart",
          displayName: "MightyPart",
        },
        role: {
          id: 38353811,
          name: "NamelessGuy2005 - Scriptor",
          rank: 255,
        },
      },
      actionType: "Accept Ally Request",
      description: {
        TargetGroupId: 6333562,
        TargetGroupName: "Mine Ways Talk Show",
      },
      created: "2020-05-18T12:06:34Z",
    },
    {
      actor: {
        user: {
          hasVerifiedBadge: false,
          userId: 45348281,
          username: "MightyPart",
          displayName: "MightyPart",
        },
        role: {
          id: 38353811,
          name: "NamelessGuy2005 - Scriptor",
          rank: 255,
        },
      },
      actionType: "Accept Ally Request",
      description: {
        TargetGroupId: 5257567,
        TargetGroupName: "The X1 Team",
      },
      created: "2020-05-13T13:52:57Z",
    },
    {
      actor: {
        user: {
          hasVerifiedBadge: false,
          userId: 45348281,
          username: "MightyPart",
          displayName: "MightyPart",
        },
        role: {
          id: 38353811,
          name: "NamelessGuy2005 - Scriptor",
          rank: 255,
        },
      },
      actionType: "Accept Ally Request",
      description: {
        TargetGroupId: 5894486,
        TargetGroupName: "Sky-Blox Studio",
      },
      created: "2020-05-13T13:52:56Z",
    },
  ],
} 

Endpoint

GET /v1/groups/{groupId}/audit-log