Get an audit event

Fetch a specific audit event by ID.

URL: https://api.courier.com/audit-events/:audit-event-id

Method: GET

Path Parameters

audit-event-idstringrequired

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

Response

status: 200 OK

auditEventIdstring

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

actorobject

+ Show Properties

targetobject

+ Show Properties

sourcestring

A unique identifier representing the source of the audit event.

timestampstring

A UTC timestamp at which the audit event was triggered.

typestring

The type of audit event that was triggered.

Request Example

cURL

curl --request GET \
     --url https://api.courier.com/audit-events/ZX3xXUMNKL4y2NkiKgstl \
     --header 'Accept: application/json' 

Node.js

// Dependencies to install:
// $ npm install node-fetch --save

const fetch = require('node-fetch');

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json'
  },
};

fetch('https://api.courier.com/audit-events/ZX3xXUMNKL4y2NkiKgstl', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.courier.com/audit-events/ZX3xXUMNKL4y2NkiKgstl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'

response = http.request(request)
puts response.read_body

Python

# Dependencies to install:
# $ python -m pip install requests

import requests

url = "https://api.courier.com/audit-events/ZX3xXUMNKL4y2NkiKgstl"

headers = {
  "Accept": "application/json"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.courier.com/audit-events/ZX3xXUMNKL4y2NkiKgstl"

  req, _ := http.NewRequest("GET", url, payload)

  req.Header.Add("Accept", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

PHP

<?php
// Dependencies to install:
// $ composer require guzzlehttp/guzzle

require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.courier.com/audit-events/ZX3xXUMNKL4y2NkiKgstl', [
  'headers' => [
    'Accept' => 'application/json',
  ],
]);

echo $response->getBody();

Responses Example

{
  "auditEventId": "ZX3xXUMNKL4y2NkiKgstl",
  "actor": {
    "id": "foo-user",
    "email": "joe.fake@gmail.com"
  },
  "target": {
    "id": "EF607F6E84A34305AE98B6TR",
    "email": "jane.doe@gmail.com"
  },
  "source": "courier.studio",
  "timestamp": "2022-07-05T22:30:24.662Z",
  "type": "user:role-changed"
}