cURL
curl --request GET \
--url https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}', 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.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}",
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.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}"
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.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}")
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{
"id": "<string>",
"orgId": "<string>",
"type": "SOC2_SUMMARY",
"title": "<string>",
"description": "<string>",
"status": "PENDING",
"format": "JSON",
"parameters": {},
"content": {},
"errorMessage": "<string>",
"generatedBy": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"completedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}API Reference
Get orgs compliancereports 1
GET
/
orgs
/
{orgId}
/
compliance
/
reports
/
{reportId}
cURL
curl --request GET \
--url https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}', 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.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}",
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.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}"
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.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports/{reportId}")
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{
"id": "<string>",
"orgId": "<string>",
"type": "SOC2_SUMMARY",
"title": "<string>",
"description": "<string>",
"status": "PENDING",
"format": "JSON",
"parameters": {},
"content": {},
"errorMessage": "<string>",
"generatedBy": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"completedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}Authorizations
BearerAuthApiKeyAuth
JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer
Response
200 - application/json
OK
A compliance report record
Unique report identifier
Organization identifier
Type of compliance report
Available options:
SOC2_SUMMARY, ACTIVITY_REPORT, ACCESS_REVIEW, AUDIT_EXPORT, GDPR_DSAR Report title
Report description
Current status of the report
Available options:
PENDING, GENERATING, COMPLETED, FAILED Export format for the report
Available options:
JSON, CSV, PDF Report generation parameters
Show child attributes
Show child attributes
Report content data
Show child attributes
Show child attributes
Error message if report generation failed
User who generated the report
ISO 8601 report period start
ISO 8601 report period end
ISO 8601 completion timestamp
ISO 8601 creation timestamp
ISO 8601 last update timestamp
