Browser Profiles

List browser profiles

Get all browser profiles for the organization

get/v1/browser_profiles

Query parameters

pageinteger
page_sizeinteger
include_deletedboolean

Include deleted browser profiles

Include deleted browser profiles

search_keystring nullable

Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches.

Example:my_profile

Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches.

managedboolean nullable

Omit to return all profiles; false returns only user-created profiles; true returns only auto-managed profiles.

Omit to return all profiles; false returns only user-created profiles; true returns only auto-managed profiles.

Headers

x-api-keystring nullable

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

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

Response

Successfully retrieved browser profiles

browser_profile_idstring required
organization_idstring required
namestring required
descriptionstring nullable
source_browser_typestring nullable
proxy_session_idstring nullable
is_managedboolean
workflow_permanent_idstring nullable
browser_profile_key_digeststring nullable
created_atstring date-time required
modified_atstring date-time required
deleted_atstring date-time nullable
last_verified_login_atstring date-time nullable
linked_credential_namestring nullable

Example response

[
  {
    "proxy_location": {
      "country": "US",
      "subdivision": "CA",
      "city": "New York"
    }
  }
]

Changes

Changed in 6 of the 86 revisions of this API.217

    • 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 new optional query request parameter managed

      new-optional-request-parameter

    • 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

    • response property items/deleted_at 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 items/description list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • added the new optional query request parameter page

      new-optional-request-parameter

    • added the new optional query request parameter page_size

      new-optional-request-parameter

    • added the new optional query request parameter search_key

      new-optional-request-parameter

    • 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

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • 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