Skip to main content
GET
/
v1
/
credentials
Get all credentials
curl --request GET \
  --url https://api.skyvern.com/v1/credentials
[
  {
    "credential_id": "<string>",
    "credential": {
      "username": "<string>",
      "totp_type": "none",
      "totp_identifier": "user@example.com"
    },
    "name": "<string>",
    "browser_profile_id": "<string>",
    "tested_url": "<string>",
    "user_context": "<string>",
    "save_browser_session_intent": true,
    "folder_id": "cfld_1234567890",
    "proxy_session_id": "<string>"
  }
]

Headers

​
x-api-key
string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
Example:

1

​
page_size
integer
default:10

Number of items per page

Required range: x >= 1
Example:

10

​
vault_type
enum<string> | null

Filter credentials by vault type (e.g. 'custom', 'bitwarden', 'azure_vault')

Available options:
bitwarden,
azure_vault,
gcp,
custom
​
credential_type
enum<string> | null

Filter credentials by type (e.g. 'password', 'credit_card', 'secret') Type of credential stored in the system.

Available options:
password,
credit_card,
secret
​
search
string | null

Case-insensitive search across credential name, username, secret label, and card details

Maximum string length: 200

Response

Successful Response

​
credential_id
string
required

Unique identifier for the credential

Example:

"cred_1234567890"

​
credential
PasswordCredentialResponse · object
required

Response model for password credentials — non-sensitive fields only.

SECURITY: Must NEVER include password or TOTP secret.

​
credential_type
enum<string>
required

Type of the credential

Available options:
password,
credit_card,
secret
​
name
string
required

Name of the credential

Example:

"Amazon Login"

​
vault_type
enum<string> | null

Which vault stores this credential (e.g., 'bitwarden', 'azure_vault', 'custom')

Available options:
bitwarden,
azure_vault,
gcp,
custom
​
browser_profile_id
string | null

Browser profile ID linked to this credential

​
tested_url
string | null

Login page URL used during the credential test

​
user_context
string | null

User-provided context describing the login sequence (e.g., 'click SSO button first')

​
save_browser_session_intent
boolean | null

Whether the user intends to save a browser session, regardless of test outcome

​
folder_id
string | null

ID of the credential folder this credential belongs to, if any

Example:

"cfld_1234567890"

​
proxy_location

Optional proxy location used for the credential's pinned proxy identity.

Available options:
RESIDENTIAL,
US-CA,
US-NY,
US-TX,
US-FL,
US-WA,
RESIDENTIAL_ES,
RESIDENTIAL_IE,
RESIDENTIAL_GB,
RESIDENTIAL_IN,
RESIDENTIAL_JP,
RESIDENTIAL_FR,
RESIDENTIAL_DE,
RESIDENTIAL_NZ,
RESIDENTIAL_ZA,
RESIDENTIAL_AR,
RESIDENTIAL_AU,
RESIDENTIAL_BR,
RESIDENTIAL_TR,
RESIDENTIAL_CA,
RESIDENTIAL_MX,
RESIDENTIAL_IT,
RESIDENTIAL_NL,
RESIDENTIAL_PH,
RESIDENTIAL_KR,
RESIDENTIAL_SA,
RESIDENTIAL_ISP,
NONE
​
proxy_session_id
string | null

Opaque Skyvern-managed proxy sticky-session id.