Skip to main content
GET
/
credentials
List Credentials
curl --request GET \
  --url https://api.example.com/credentials
{
  "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 the authenticate task action.

​
Example Request

curl -X GET "https://api.scrapengine.io/api/v1/credentials" \
  -H "Authorization: Bearer $SCRAPENGINE_API_KEY"

​
Response

​
Success Response (200)

Returns an array of credential records.
​
id
string
Credential ID (UUID).
​
name
string
Human-readable name.
​
vaultIntegrationId
string
Vault integration this credential reads from.
​
vaultPath
string
Path inside the vault.
​
fieldMap
object
Maps vault field names to username / password / optional totp.
​
allowedDomains
string[]
Hostnames this credential may be used on.
​
createdAt
string
ISO 8601 timestamp.
​
updatedAt
string
ISO 8601 timestamp.
Example Response: 
[
  {
    "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

StatusDescription
401Unauthorized — invalid or missing API key.