> ## Documentation Index
> Fetch the complete documentation index at: https://skyvern.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get all credentials

> Retrieves a paginated list of credentials for the current organization



## OpenAPI

````yaml /api-reference/openapi.json get /v1/credentials
openapi: 3.1.0
info:
  title: Skyvern API
  description: API for Skyvern
  version: 1.0.0
servers:
  - url: https://api.skyvern.com
    x-fern-server-name: Cloud
  - url: https://api-staging.skyvern.com
    x-fern-server-name: Staging
  - url: http://localhost:8000
    x-fern-server-name: Local
security: []
paths:
  /v1/credentials:
    get:
      tags:
        - Credentials
      summary: Get all credentials
      description: Retrieves a paginated list of credentials for the current organization
      operationId: get_credentials_v1_credentials_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number for pagination
            examples:
              - 1
            openapi_extra:
              x-fern-sdk-parameter-name: page
            default: 1
            title: Page
          description: Page number for pagination
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Number of items per page
            examples:
              - 10
            openapi_extra:
              x-fern-sdk-parameter-name: page_size
            default: 10
            title: Page Size
          description: Number of items per page
        - name: vault_type
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/CredentialVaultType'
              - type: 'null'
            description: >-
              Filter credentials by vault type (e.g. 'custom', 'bitwarden',
              'azure_vault')
            title: Vault Type
          description: >-
            Filter credentials by vault type (e.g. 'custom', 'bitwarden',
            'azure_vault')
        - name: credential_type
          in: query
          required: false
          schema:
            anyOf:
              - $ref: >-
                  #/components/schemas/skyvern__forge__sdk__schemas__credentials__CredentialType
              - type: 'null'
            description: >-
              Filter credentials by type (e.g. 'password', 'credit_card',
              'secret')
            title: Credential Type
          description: >-
            Filter credentials by type (e.g. 'password', 'credit_card',
            'secret')
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 200
              - type: 'null'
            description: >-
              Case-insensitive search across credential name, username, secret
              label, and card details
            title: Search
          description: >-
            Case-insensitive search across credential name, username, secret
            label, and card details
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Skyvern API key for authentication. API key can be found at
              https://app.skyvern.com/settings.
            title: X-Api-Key
          description: >-
            Skyvern API key for authentication. API key can be found at
            https://app.skyvern.com/settings.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CredentialResponse'
                title: Response Get Credentials V1 Credentials Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CredentialVaultType:
      type: string
      enum:
        - bitwarden
        - azure_vault
        - gcp
        - custom
      title: CredentialVaultType
    skyvern__forge__sdk__schemas__credentials__CredentialType:
      type: string
      enum:
        - password
        - credit_card
        - secret
      title: CredentialType
      description: Type of credential stored in the system.
    CredentialResponse:
      properties:
        credential_id:
          type: string
          title: Credential Id
          description: Unique identifier for the credential
          examples:
            - cred_1234567890
        credential:
          anyOf:
            - $ref: '#/components/schemas/PasswordCredentialResponse'
            - $ref: '#/components/schemas/CreditCardCredentialResponse'
            - $ref: '#/components/schemas/SecretCredentialResponse'
          title: Credential
          description: The credential data
        credential_type:
          $ref: '#/components/schemas/CredentialType-Output'
          description: Type of the credential
        name:
          type: string
          title: Name
          description: Name of the credential
          examples:
            - Amazon Login
        vault_type:
          anyOf:
            - $ref: '#/components/schemas/CredentialVaultType'
            - type: 'null'
          description: >-
            Which vault stores this credential (e.g., 'bitwarden',
            'azure_vault', 'custom')
        browser_profile_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Browser Profile Id
          description: Browser profile ID linked to this credential
        tested_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Tested Url
          description: Login page URL used during the credential test
        user_context:
          anyOf:
            - type: string
            - type: 'null'
          title: User Context
          description: >-
            User-provided context describing the login sequence (e.g., 'click
            SSO button first')
        save_browser_session_intent:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Save Browser Session Intent
          description: >-
            Whether the user intends to save a browser session, regardless of
            test outcome
        folder_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Id
          description: ID of the credential folder this credential belongs to, if any
          examples:
            - cfld_1234567890
        proxy_location:
          anyOf:
            - $ref: '#/components/schemas/ProxyLocation'
            - $ref: '#/components/schemas/GeoTarget'
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Proxy Location
          description: >-
            Optional proxy location used for the credential's pinned proxy
            identity.
        proxy_session_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Proxy Session Id
          description: Opaque Skyvern-managed proxy sticky-session id.
      type: object
      required:
        - credential_id
        - credential
        - credential_type
        - name
      title: CredentialResponse
      description: Response model for credential operations.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PasswordCredentialResponse:
      properties:
        username:
          type: string
          title: Username
          description: The username associated with the credential
          examples:
            - user@example.com
        totp_type:
          $ref: '#/components/schemas/TotpType'
          description: Type of 2FA method used for this credential
          default: none
          examples:
            - authenticator
        totp_identifier:
          anyOf:
            - type: string
            - type: 'null'
          title: Totp Identifier
          description: Identifier (email or phone number) used to fetch TOTP codes
          examples:
            - user@example.com
            - '+14155550123'
      type: object
      required:
        - username
      title: PasswordCredentialResponse
      description: |-
        Response model for password credentials — non-sensitive fields only.

        SECURITY: Must NEVER include password or TOTP secret.
    CreditCardCredentialResponse:
      properties:
        last_four:
          type: string
          title: Last Four
          description: Last four digits of the credit card number
          examples:
            - '1234'
        brand:
          type: string
          title: Brand
          description: Brand of the credit card
          examples:
            - visa
      type: object
      required:
        - last_four
        - brand
      title: CreditCardCredentialResponse
      description: >-
        Response model for credit card credentials — non-sensitive fields only.


        SECURITY: Must NEVER include full card number, CVV, expiration date,
        card holder name,

        billing fields, or metadata.
    SecretCredentialResponse:
      properties:
        secret_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Secret Label
          description: Optional label for the stored secret
      type: object
      title: SecretCredentialResponse
      description: |-
        Response model for secret credentials — non-sensitive fields only.

        SECURITY: Must NEVER include the secret_value.
    CredentialType-Output:
      type: string
      enum:
        - password
        - credit_card
        - secret
      title: CredentialType
      description: Type of credential stored in the system.
    ProxyLocation:
      type: string
      enum:
        - 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
      title: ProxyLocation
    GeoTarget:
      properties:
        country:
          type: string
          maxLength: 2
          minLength: 2
          title: Country
          description: ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE')
          examples:
            - US
            - GB
            - DE
            - FR
        subdivision:
          anyOf:
            - type: string
              maxLength: 10
            - type: 'null'
          title: Subdivision
          description: >-
            ISO 3166-2 subdivision code without country prefix (e.g., 'CA' for
            California, 'NY' for New York)
          examples:
            - CA
            - NY
            - TX
            - ENG
        city:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: City
          description: >-
            City name in English from GeoNames (e.g., 'New York', 'Los Angeles',
            'London')
          examples:
            - New York
            - Los Angeles
            - London
            - Berlin
      type: object
      required:
        - country
      title: GeoTarget
      description: >-
        Granular proxy geo-targeting request with country, optional subdivision,
        and optional city.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    TotpType:
      type: string
      enum:
        - authenticator
        - email
        - text
        - none
      title: TotpType
      description: Type of 2FA/TOTP method used.

````