Skip to main content
GET
/
audit-events
/
{audit-event-id}
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const auditEvent = await client.auditEvents.retrieve('audit-event-id');

console.log(auditEvent.actor);
import os
from courier import Courier

client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
audit_event = client.audit_events.retrieve(
"audit-event-id",
)
print(audit_event.actor)
package main

import (
"context"
"fmt"

"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)

func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
auditEvent, err := client.AuditEvents.Get(context.TODO(), "audit-event-id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", auditEvent.Actor)
}
package com.courier.example;

import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.auditevents.AuditEvent;
import com.courier.models.auditevents.AuditEventRetrieveParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();

AuditEvent auditEvent = client.auditEvents().retrieve("audit-event-id");
}
}
require "courier"

courier = Courier::Client.new(api_key: "My API Key")

audit_event = courier.audit_events.retrieve("audit-event-id")

puts(audit_event)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Courier\Client;
use Courier\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');

try {
$auditEvent = $client->auditEvents->retrieve('audit-event-id');

var_dump($auditEvent);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using TryCourier;
using TryCourier.Models.AuditEvents;

CourierClient client = new();

AuditEventRetrieveParams parameters = new() { AuditEventID = "audit-event-id" };

var auditEvent = await client.AuditEvents.Retrieve(parameters);

Console.WriteLine(auditEvent);
courier audit-events retrieve \
--api-key 'My API Key' \
--audit-event-id audit-event-id
curl --request GET \
--url https://api.courier.com/audit-events/{audit-event-id} \
--header 'Authorization: Bearer <token>'
{
  "auditEventId": "abc-123",
  "actor": {
    "id": "abc-123",
    "email": "user@example.com"
  },
  "target": "string",
  "source": "string",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "type": "string"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

audit-event-id
string
required

A unique identifier associated with the audit event you wish to retrieve

Response

200 - application/json
auditEventId
string
required
actor
Actor · object
required
target
string
required
source
string
required
timestamp
string
required
type
string
required