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

auto_profile_disabledboolean nullable

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

pin_saved_session_ipboolean

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

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

run_sequentiallyboolean

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 9 of the 86 revisions of this API.2316

Aug 8, 20265116249dfff31See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 30, 202630201945bb651See the full diff
- ●
  added the new passkey enum value to the // response property for the response status
  response-property-enum-value-added
Jul 30, 2026b28e44e0ebec1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 24, 2026bd64e0480f0a1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 2, 202667aeacca9d051See the full diff
- ●
  added the new skyvern enum value to the / response property for the response status
  response-property-enum-value-added
Jun 26, 20269de266eb002a2See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jun 12, 20267ce5e3e9a5601See the full diff
- ●
  added the new gcp enum value to the / response property for the response status
  response-property-enum-value-added
Jun 8, 20263a3616091b66210See the full diff
- ▲
  response property credential/anyOf[subschema #1: PasswordCredentialResponse]/totp_identifier list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property credential/anyOf[subschema #3: SecretCredentialResponse]/secret_label list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  header request parameter x-api-key list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  for the header request parameter x-api-key, the type was generalized from string to no type
  request-parameter-type-generalized
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 4, 2026a8899e7707c41See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history