Skip to main content
GET
/
v1
/
scans
List scans
curl --request GET \
  --url https://api.passlet.io/v1/scans \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.passlet.io/v1/scans"

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

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

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

fetch('https://api.passlet.io/v1/scans', 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.passlet.io/v1/scans",
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.passlet.io/v1/scans"

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.passlet.io/v1/scans")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.passlet.io/v1/scans")

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
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "passId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "templateVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "redemptionSnapshot": {
        "windows": [
          {
            "start": "<string>",
            "end": "<string>",
            "maxUses": 50000
          }
        ],
        "maxUses": 50000,
        "perPeriod": {
          "count": 50000,
          "timezone": "<string>"
        },
        "minIntervalMinutes": 263520,
        "activation": {
          "basis": "<string>",
          "validForHours": 43920
        }
      },
      "scanContextKey": "<string>",
      "scannedAt": "2023-11-07T05:31:56Z",
      "recordedAt": "2023-11-07T05:31:56Z",
      "reversesScanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deviceId": "<string>",
      "context": {},
      "externalRef": "<string>",
      "reason": "<string>",
      "matchedCount": 4503599627370495,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0,
  "hasMore": true,
  "nextCursor": "<string>"
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}

Authorizations

Authorization
string
header
required

Passlet access token (plt_*) sent as Authorization: Bearer <token> or X-API-Key. Authorized scopes are listed per operation under x-required-scopes.

Query Parameters

limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
cursor
string

Opaque cursor returned by the previous page

Required string length: 1 - 512
offset
integer
default:0

Deprecated offset compatibility parameter

Required range: 0 <= x <= 9007199254740991
projectId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
passId
string<uuid>

Pass identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
templateId
string<uuid>

Template identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
result
enum<string>[]

Filter by one or more scan results (any-of).

Minimum array length: 1
Available options:
accepted,
duplicate,
unknown,
ambiguous,
denied,
reversal
resultGroup
enum<string>
Available options:
denied
scanContextKey
string
Maximum string length: 128
scannedSince
string<date-time>

ISO 8601 timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
scannedUntil
string<date-time>

ISO 8601 timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

OK

items
object[]
required
total
integer
required

Total number of items

Required range: -9007199254740991 <= x <= 9007199254740991
limit
integer
required

Items per page

Required range: -9007199254740991 <= x <= 9007199254740991
offset
integer
required

Items skipped

Required range: -9007199254740991 <= x <= 9007199254740991
hasMore
boolean
required

Whether more items exist

nextCursor
string | null

Opaque cursor for the next page, or null when exhausted