Get all credentials

curl --request GET \
  --url https://api.skyvern.com/v1/credentials \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.skyvern.com/v1/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.skyvern.com/v1/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.skyvern.com/v1/credentials"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.skyvern.com/v1/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "credential_id": "cred_1234567890",
    "credential": {
      "username": "user@example.com",
      "totp_type": "authenticator",
      "totp_identifier": "user@example.com",
      "has_totp": false
    },
    "credential_type": "password",
    "name": "Amazon Login",
    "vault_type": "skyvern",
    "vault_id": "<string>",
    "item_id": "<string>",
    "upstream_missing_at": "2023-11-07T05:31:56Z",
    "browser_profile_id": "<string>",
    "auto_profile_disabled": true,
    "pin_saved_session_ip": false,
    "tested_url": "<string>",
    "extra_site_urls": [
      "<string>"
    ],
    "user_context": "<string>",
    "save_browser_session_intent": true,
    "run_sequentially": false,
    "folder_id": "cfld_1234567890",
    "proxy_location": "RESIDENTIAL",
    "proxy_session_id": "<string>",
    "created_by": "<string>"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

credentials

Get all credentials

curl --request GET \
  --url https://api.skyvern.com/v1/credentials \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.skyvern.com/v1/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.skyvern.com/v1/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.skyvern.com/v1/credentials"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.skyvern.com/v1/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "credential_id": "cred_1234567890",
    "credential": {
      "username": "user@example.com",
      "totp_type": "authenticator",
      "totp_identifier": "user@example.com",
      "has_totp": false
    },
    "credential_type": "password",
    "name": "Amazon Login",
    "vault_type": "skyvern",
    "vault_id": "<string>",
    "item_id": "<string>",
    "upstream_missing_at": "2023-11-07T05:31:56Z",
    "browser_profile_id": "<string>",
    "auto_profile_disabled": true,
    "pin_saved_session_ip": false,
    "tested_url": "<string>",
    "extra_site_urls": [
      "<string>"
    ],
    "user_context": "<string>",
    "save_browser_session_intent": true,
    "run_sequentially": false,
    "folder_id": "cfld_1234567890",
    "proxy_location": "RESIDENTIAL",
    "proxy_session_id": "<string>",
    "created_by": "<string>"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

Your Skyvern API key from https://app.skyvern.com/settings.

Query Parameters

page

integer

default:1

Page number for pagination

Required range: 1 <= x <= 1000000

Example:

1

page_size

integer

default:10

Number of items per page

Required range: 1 <= x <= 1000

Example:

10

vault_type

enum<string> | null

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

Available options:

skyvern,

bitwarden,

azure_vault,

gcp,

aws_secrets_manager,

custom,

onepassword,

bitwarden_connected

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

string | null

Case-insensitive search across credential name, username, secret label, and card details, or an exact credential ID

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.

PasswordCredentialResponse
CreditCardCredentialResponse
SecretCredentialResponse

Show child attributes

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., 'skyvern', 'bitwarden', 'azure_vault', 'custom')

Available options:

skyvern,

bitwarden,

azure_vault,

gcp,

aws_secrets_manager,

custom,

onepassword,

bitwarden_connected

vault_id

string | null

1Password vault ID for linked credentials

item_id

string | null

1Password item ID for linked credentials

upstream_missing_at

string<date-time> | null

When the linked 1Password item was last found missing upstream

browser_profile_id

string | null

Browser profile ID linked to this credential

auto_profile_disabled

boolean | null

Whether automatic saving and reuse of this credential's browser profile is disabled.

pin_saved_session_ip

boolean

default:false

Whether sign-ins reusing this credential's saved profile keep the same IP

tested_url

string | null

extra_site_urls

string[]

More sites this login may sign in on, each covering its whole site

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

run_sequentially

boolean

default:false

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.

created_by

string | null

ID of the user who created the credential

Agents

Runs

Folders

Server

Artifacts

Files

Browser Profiles

Browser Sessions

Credentials

Schedules

Recipes

Get all credentials

Authorizations

Query Parameters

Response