Credentials

Get credential by ID

Retrieves a specific credential by its ID

get/v1/credentials/{credential_id}

Path parameters

credential_idstring required

The unique identifier of the credential

Example:cred_1234567890

The unique identifier of the credential

Headers

x-api-keystring nullable

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

Response

Successful Response

credential_idstring required

Unique identifier for the credential

credential_type'password' | 'credit_card' | 'secret' required

Type of credential stored in the system.

namestring required

Name of the credential

vault_type'skyvern' | 'bitwarden' | 'azure_vault' | 'gcp' | 'custom'

browser_profile_idstring nullable

Browser profile ID linked to this credential

tested_urlstring nullable

user_contextstring nullable

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

save_browser_session_intentboolean nullable

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

folder_idstring nullable

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

proxy_session_idstring nullable

Opaque Skyvern-managed proxy sticky-session id.

Example response

{
  "credential_id": "cred_1234567890",
  "credential": {
    "username": "user@example.com",
    "totp_identifier": "user@example.com"
  },
  "name": "Amazon Login",
  "folder_id": "cfld_1234567890",
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Changes

Changed in 13 of the 63 revisions of this API.811

Jul 30, 202619ebfe1446041See the full diff
- ●
  added the new passkey enum value to the credential/anyOf[subschema #1: PasswordCredentialResponse]/totp_type response property for the response status 200
  response-property-enum-value-added
Jul 14, 20261b9c7c96c0102See the full diff
- ○
  added the optional property proxy_location to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property proxy_session_id to the response with the 200 status
  response-optional-property-added
Jul 14, 202666da0fa97dc52See the full diff
- ●
  removed the optional property proxy_location from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property proxy_session_id from the response with the 200 status
  response-optional-property-removed
This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 14, 20261b9c7c96c0102See the full diff
- ○
  added the optional property proxy_location to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property proxy_session_id to the response with the 200 status
  response-optional-property-added
Jul 2, 2026fb9f144b21fa1See the full diff
- ●
  added the new skyvern enum value to the vault_type/anyOf[subschema #1: CredentialVaultType]/ response property for the response status 200
  response-property-enum-value-added
Jun 13, 2026e7044f43e57e1See the full diff
- ●
  added the new gcp enum value to the vault_type/anyOf[subschema #1: CredentialVaultType]/ response property for the response status 200
  response-property-enum-value-added
Jun 7, 2026e37d309fc58f1See the full diff
- ○
  added the optional property folder_id to the response with the 200 status
  response-optional-property-added
Mar 26, 2026d70a0640ef292See the full diff
- ○
  added the optional property save_browser_session_intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property vault_type to the response with the 200 status
  response-optional-property-added
This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 26, 2026458f1f2bbd452See the full diff
- ●
  removed the optional property save_browser_session_intent from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property vault_type from the response with the 200 status
  response-optional-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 26, 2026d70a0640ef292See the full diff
- ○
  added the optional property save_browser_session_intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property vault_type to the response with the 200 status
  response-optional-property-added
This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (13 revisions)