Skip to main content
GET
/
v1
/
audit-logs
List audit logs
curl --request GET \
  --url https://api.hyperline.co/v1/audit-logs \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.hyperline.co/v1/audit-logs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hyperline.co/v1/audit-logs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperline.co/v1/audit-logs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.hyperline.co/v1/audit-logs"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.hyperline.co/v1/audit-logs")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/audit-logs")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "type": "invoice.electronic_invoice.sent",
      "happened_at": "2024-10-20T14:32:11.000Z",
      "customer_id": "cus_Typ0px2W0aiEtl",
      "subscription_id": null,
      "invoice_id": "inv_1eTaiytfA0i2Va",
      "quote_id": null
    }
  ],
  "next_cursor": null,
  "has_more": false,
  "total": 1
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:50

Maximum number of items to return (1-100).

Required range: x <= 100
Example:

50

cursor
string

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

include_total
default:false

Set to true to include total in the response.

Example:

false

customer_id
string

Return only entries attached to this customer ID.

Example:

"cus_Typ0px2W0aiEtl"

subscription_id
string

Return only entries attached to this subscription ID.

Example:

"sub_amiaWZ3lzDIWaoT"

invoice_id
string

Return only entries attached to this invoice ID.

Example:

"inv_1eTaiytfA0i2Va"

quote_id
string

Return only entries attached to this quote ID.

Example:

"quo_1eTaiytfA0i2Va"

Response

200 - application/json
data
(Audit log · object | Email audit log · object)[]
required

List of AuditLog.

next_cursor
string | null
required

Cursor to fetch the next page. null when there are no more items.

Example:

null

has_more
boolean
required

Whether more items are available after this page.

Example:

false

total
number

Total number of items matching the filters. Only present when include_total=true was passed.

Example:

1