List Credentials
curl --request GET \
--url https://api.example.com/credentialsimport requests
url = "https://api.example.com/credentials"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/credentials', 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.example.com/credentials",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/credentials"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/credentials")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"vaultIntegrationId": "<string>",
"vaultPath": "<string>",
"fieldMap": {},
"allowedDomains": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>"
}Credentials & Vault
List Credentials
List the caller’s credential records. Metadata only — no secret material is ever returned.
GET
/
credentials
List Credentials
curl --request GET \
--url https://api.example.com/credentialsimport requests
url = "https://api.example.com/credentials"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/credentials', 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.example.com/credentials",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/credentials"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/credentials")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"vaultIntegrationId": "<string>",
"vaultPath": "<string>",
"fieldMap": {},
"allowedDomains": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>"
}Overview
Returns every credential record owned by the caller. Only metadata is returned (name, vault integration ID, vault path, field map, allowed domains, timestamps) — the underlying secret never leaves your vault and is not included in the response. Credential IDs returned here are what you pass to theauthenticate task action.
Example Request
curl -X GET "https://api.scrapengine.io/api/v1/credentials" \
-H "Authorization: Bearer $SCRAPENGINE_API_KEY"
const response = await fetch("https://api.scrapengine.io/api/v1/credentials", {
headers: {
"Authorization": `Bearer ${process.env.SCRAPENGINE_API_KEY}`,
},
});
const data = await response.json();
import requests
response = requests.get(
"https://api.scrapengine.io/api/v1/credentials",
headers={"Authorization": f"Bearer {SCRAPENGINE_API_KEY}"},
)
data = response.json()
Response
Success Response (200)
Returns an array of credential records.string
Credential ID (UUID).
string
Human-readable name.
string
Vault integration this credential reads from.
string
Path inside the vault.
object
Maps vault field names to
username / password / optional totp.string[]
Hostnames this credential may be used on.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
[
{
"id": "2b5aa4c8-b9e6-4e58-9c80-1d4bfd0a3f01",
"name": "Alice @ app.example.com",
"vaultIntegrationId": "5f8c6a74-5f2e-4f5a-9e58-5b9c3c7d2a11",
"vaultPath": "secret/data/login-alice",
"fieldMap": { "username": "username", "password": "password" },
"allowedDomains": ["app.example.com"],
"createdAt": "2026-04-24T09:12:44Z",
"updatedAt": "2026-04-24T09:12:44Z"
}
]
Error Responses
| Status | Description |
|---|---|
401 | Unauthorized — invalid or missing API key. |
Was this page helpful?