List attestations

Get a paginated list of attestations for an organization based on filters provided as query parameters.

GET /attestations/{org}

List attestations

cURL

curl --request GET \
  --url https://app.kosli.com/api/v2/attestations/{org} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.kosli.com/api/v2/attestations/{org}"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.kosli.com/api/v2/attestations/{org}', 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://app.kosli.com/api/v2/attestations/{org}",
  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://app.kosli.com/api/v2/attestations/{org}"

	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://app.kosli.com/api/v2/attestations/{org}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kosli.com/api/v2/attestations/{org}")

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

200

{
  "data": [
    {}
  ],
  "_links": {},
  "pagination": {
    "total": 123,
    "page": 123,
    "per_page": 123,
    "page_count": 123
  }
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization · string · header · required

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

Path Parameters

org · string · required

Query Parameters

attestation_id · string | null

The attestation ID to search for

name · string | null

Filter by exact attestation name. Cannot be combined with name_regex.

name_regex · string | null

Filter by attestation name (substring regex match)

flow · string[] | null

Filter by flow name. Repeat the parameter to match several flows.

type · string[] | null

Filter by attestation type. Use built-in types (e.g. 'junit', 'decision') or 'custom:' for custom types. Repeat the parameter to match several types.

is_compliant · boolean | null

Filter by compliance state. Omit to include both compliant and non-compliant.

from_timestamp · integer | null

From timestamp filter. Example: ?from_timestamp=1675167540

to_timestamp · integer | null

To timestamp filter. Example: ?to_timestamp=1675167540

after · string | null

Cursor for the next page. Use the token from a previous response's _links.next; omit for the first page.

per_page · integer | null · default: 20

How many results to return per page of response (max 100)

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response

data · AttestationResponse · object[] · required

Example:

[
  {
    "attestation_id": "1234567890",
    "attestation_name": "generic-evidence",
    "attestation_type": "generic",
    "created_at": 1754551048.2005377,
    "description": "generic attestation",
    "has_audit_package": false,
    "html_url": "http://localhost/b2cebc00v2-shared/flows/flow.b2cebc00-template/trails/trail-b2cebc00?attestation_id=cd5b2c7f-8e4d-45a4-949c-8a71cbdb",
    "is_compliant": true,
    "origin_url": "https://github.com/merkely-development/merkely/actions/runs/1049309666",
    "reported_by": "b2cebc00v2",
    "schema_version": 1,
    "user_data": { "foo.bar": "this should work" }
  }
]

_links · Links · object | null

pagination · PaginationInfo · object | null

Show child attributes