---
title: "Get audits"
method: GET
path: "/audits/company/{companyId}"
tags: ["Audits"]
---

# Get audits

`GET /audits/company/{companyId}`

## Path parameters

- `companyId` integer, required

## Query parameters

- `filter[createdAt]` string, date-time
- `filter[event]` 'accepted' | 'acknowledged' | 'actionsReminder' | 'activated' | 'added' | 'addedAttribute' | 'addedCompanySubdomain' | 'addedDomain' | 'anonymized' | 'answer' | 'archived' | 'assignedQuestions' | 'authentication' | 'blocked' | 'bounced' | 'changedRole' | 'clear' | 'clearedComplaints' | 'cleared_bounces' | 'close' | 'complained' | 'completed' | 'confirmationRequest' | 'confirmed' | 'consent' | 'correlated' | 'create' | 'created' | 'createdCompanyShard' | 'dailySent' | 'dataObliterateStarted' | 'delete' | 'deleted' | 'deletedComment' | 'deletedCompanyShard' | 'deletedCompanySubdomain' | 'deletedInput' | 'disabled' | 'employeeAttributesChanged' | 'enabled' | 'ended' | 'exceeded' | 'expired' | 'frequenciesUpdated' | 'generateAuthenticationCode' | 'generatedAgentToken' | 'generatedLogHash' | 'hard-close' | 'hookDisabled' | 'hookEnabled' | 'hookFailed' | 'hookFired' | 'hookPaused' | 'importStarted' | 'imported' | 'incompleted' | 'lowParticipation' | 'markAllAsRead' | 'markAllAsViewed' | 'markAsUnviewed' | 'markAsViewed' | 'markedSensitive' | 'migrated' | 'notified' | 'nps' | 'obliterated' | 'open' | 'passwordChange' | 'passwordRecovery' | 'presentation' | 'push' | 'reasonSet' | 'recalculated' | 'recoveryRequest' | 'recurred' | 'regeneratedCode' | 'regenerated_token' | 'rejected' | 'remind' | 'reminded' | 'removedAttribute' | 'removedDomain' | 'reopen' | 'resend' | 'reset' | 'resetQueued' | 'responseRequest' | 'restored' | 'resubscribed' | 'retire' | 'revealIdentity' | 'samlLoginRequest' | 'samlLogoutRequest' | 'scheduleLowParticipation' | 'scheduleRemind' | 'scheduled' | 'segmentationDisabled' | 'segmentationEnabled' | 'send' | 'sendLowParticipation' | 'sent' | 'set' | 'signup_consent_given' | 'smsReceipt' | 'smsReceived' | 'smsSent' | 'statusUpdated' | 'stripped' | 'suggested' | 'switch' | 'transferComplete' | 'transferStart' | 'twofactorRegisterCompleted' | 'twofactorRegisterStarted' | 'twofactorRemoved' | 'twofactorSms' | 'twofactorVerified' | 'unarchived' | 'unassignedQuestions' | 'unblocked' | 'uncompleted' | 'unmarkedSensitive' | 'unsubscribed' | 'upcomingRound' | 'update' | 'updated' | 'updatedPrimaryCompanySubdomain' | 'upgrade' | 'upserted' | 'useAuthenticationCode' | 'verificationStatusChanged' | 'withdrawn'
- `filter[objectType]` 'Account' | 'AccountSettings' | 'Action' | 'ActionItem' | 'ActionRejection' | 'Answer' | 'AnswerTopic' | 'AppIntegration' | 'Application' | 'Attribute' | 'AttributeHierarchy' | 'AttributeLink' | 'AttributeOption' | 'AttributeRange' | 'AttributeTreeNode' | 'Bookmark' | 'Branding' | 'Category' | 'Comment' | 'CommentSemanticSearchFeedback' | 'Company' | 'CompanyAction' | 'CompanyBenchmarkVersion' | 'CompanyResource' | 'CompanySettings' | 'Consultant' | 'Conversation' | 'ConversationMessage' | 'CustomConsent' | 'CustomConsentAccept' | 'CustomSenderDomain' | 'DenylistedTopic' | 'Device' | 'Employee' | 'EmployeeAttribute' | 'ExternalMetric' | 'ExternalMetricObservation' | 'FeatureFlip' | 'Feedback' | 'FeedbackRecipient' | 'Group' | 'GroupMember' | 'MailDomain' | 'Notification' | 'NotificationSettings' | 'Phone' | 'PriorityDriver' | 'PrioritySegment' | 'Question' | 'QuestionRule' | 'Response' | 'Round' | 'SAMLConfiguration' | 'Schedule' | 'Segment' | 'SegmentLimit' | 'SegmentLink' | 'SegmentManager' | 'SemanticTag' | 'SemanticTagFeedback' | 'SensitiveComment' | 'SensitiveConcept' | 'SensitiveKeyword' | 'Session' | 'Share' | 'TeamSuggestion' | 'TestCompany' | 'Topic' | 'TopicFeedback' | 'Value' | 'Vote'

## Response `200`

A [JSONAPI resource](http://jsonapi.org/format/#document-resource-objects) containing an array of 'audits' objects

- object
  - `data` Audits[]
    - `type` string
    - `id` string
    - `attributes` object
      - `createdAt` string, date-time
      - `event` 'activated' | 'authentication' | 'bounced' | 'complained' | 'changedRole' | 'cleared_bounces' | 'clearedComplaints' | 'completed' | 'confirmationRequest' | 'confirmed' | 'created' | 'generateAuthenticationCode' | 'generatedAgentToken' | 'passwordChange' | 'passwordRecovery' | 'presentation' | 'recoveryRequest' | 'resubscribed' | 'samlLogoutRequest' | 'signup_consent_given' | 'twofactorRegisterCompleted' | 'twofactorRegisterStarted' | 'twofactorRemoved' | 'uncompleted' | 'unsubscribed' | 'updated' | 'upserted' | 'useAuthenticationCode' | 'archived' | 'deleted' | 'incompleted' | 'suggested' | 'unarchived' | 'acknowledged' | 'deletedComment' | 'deletedInput' | 'markedSensitive' | 'unmarkedSensitive' | 'delete' | 'hookFailed' | 'hookFired' | 'hookPaused' | 'hookDisabled' | 'hookEnabled' | 'obliterated' | 'segmentationDisabled' | 'segmentationEnabled' | 'assignedQuestions' | 'unassignedQuestions' | 'revealIdentity' | 'addedDomain' | 'removedDomain' | 'anonymized' | 'blocked' | 'imported' | 'importStarted' | 'dataObliterateStarted' | 'regeneratedCode' | 'samlLoginRequest' | 'unblocked' | 'createdCompanyShard' | 'deletedCompanyShard' | 'addedCompanySubdomain' | 'updatedPrimaryCompanySubdomain' | 'deletedCompanySubdomain' | 'generatedLogHash' | 'stripped' | 'ended' | 'accepted' | 'withdrawn' | 'enabled' | 'disabled' | 'verificationStatusChanged' | 'push' | 'actionsReminder' | 'consent' | 'dailySent' | 'lowParticipation' | 'markAllAsRead' | 'markAllAsViewed' | 'notified' | 'nps' | 'smsSent' | 'upcomingRound' | 'employeeAttributesChanged' | 'correlated' | 'added' | 'markAsViewed' | 'markAsUnviewed' | 'sent' | 'smsReceipt' | 'smsReceived' | 'set' | 'migrated' | 'rejected' | 'expired' | 'retire' | 'scheduled' | 'upgrade' | 'answer' | 'clear' | 'create' | 'open' | 'remind' | 'reopen' | 'resend' | 'reset' | 'responseRequest' | 'scheduleRemind' | 'send' | 'close' | 'hard-close' | 'scheduleLowParticipation' | 'sendLowParticipation' | 'update' | 'addedAttribute' | 'recurred' | 'reminded' | 'removedAttribute' | 'frequenciesUpdated' | 'restored' | 'recalculated' | 'exceeded' | 'statusUpdated' | 'reasonSet' | 'switch' | 'transferComplete' | 'transferStart' | 'twofactorSms' | 'twofactorVerified' | 'regenerated_token' | 'resetQueued'
      - `objectType` 'Account' | 'AccountSettings' | 'Action' | 'ActionItem' | 'ActionRejection' | 'Answer' | 'AnswerTopic' | 'AppIntegration' | 'Application' | 'Attribute' | 'AttributeHierarchy' | 'AttributeLink' | 'AttributeOption' | 'AttributeRange' | 'AttributeTreeNode' | 'Bookmark' | 'Branding' | 'Category' | 'Comment' | 'CommentSemanticSearchFeedback' | 'Company' | 'CompanyAction' | 'CompanyBenchmarkVersion' | 'CompanyResource' | 'CompanySettings' | 'Consultant' | 'Conversation' | 'ConversationMessage' | 'CustomConsent' | 'CustomConsentAccept' | 'CustomSenderDomain' | 'DenylistedTopic' | 'Device' | 'Employee' | 'EmployeeAttribute' | 'ExternalMetric' | 'ExternalMetricObservation' | 'FeatureFlip' | 'Feedback' | 'FeedbackRecipient' | 'Group' | 'GroupMember' | 'MailDomain' | 'Notification' | 'NotificationSettings' | 'Phone' | 'PriorityDriver' | 'PrioritySegment' | 'Question' | 'QuestionRule' | 'Response' | 'Round' | 'SAMLConfiguration' | 'Schedule' | 'Segment' | 'SegmentLimit' | 'SegmentLink' | 'SegmentManager' | 'SemanticTag' | 'SemanticTagFeedback' | 'SensitiveComment' | 'SensitiveConcept' | 'SensitiveKeyword' | 'Session' | 'Share' | 'TeamSuggestion' | 'TestCompany' | 'Topic' | 'TopicFeedback' | 'Value' | 'Vote'
      - `objectId` integer
      - `data` object
      - `text` string
      - `address` object
      - `location` object
        - `city` string
        - `country` string
        - `countryCode` string
        - `location` object
          - `latitude` number, double
          - `longitude` number, double
      - `agent` object
        - `browser` string
        - `version` string
        - `os` string
        - `osVersion` string
    - `relationships` object
      - `account` object
        - `data` ResourceIdentifier
          - `type` string
          - `id` string
  - `included` ResourceIdentifier[] — An array of included JSONAPI resources
    - `type` string
    - `id` string

---

[API](https://skmtc.net/peakon/apis/peakon-api.md) · [All operations](https://skmtc.net/peakon/apis/peakon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peakon/peakon-api/revisions/cd09bd8acab5/schema)
