Sign in

v6

OpenAPI 3.0.4raw.githubusercontent.com2026-07-1500143.2 KB
Profile

Retrieve a list of all profiles loaded in your workspace. Use this endpoint to view a preview of each profile so you can quickly assess available profiles.

get/profiles

Query parameters

lifetimeState'created' | 'starting' | 'running' | 'terminating' | 'terminated' | 'locked' | 'loading' | 'unknown'

Represents the lifetime states of a profile, indicating which actions can be performed with the associated browser engine at each state. Possible values are:

  • Created: Profile is created; the associated browser engine is not started.
  • Starting: The associated browser engine is starting.
  • Running: The associated browser engine is currently running.
  • Terminating: The associated browser engine is in the process of terminating.
  • Terminated: The associated browser engine is not running but has been started at least once.
  • Locked: The profile is currently being used by another user.
  • Loading: The profile data or the browser engine is syncing with the cloud storage.
  • Unknown: State of the profile is undefined.

The lifetime state of the profiles to return (optional)

Response

OK.

idstring uuid required

A unique identifier of the profile

namestring required

The name of the profile

tagsstring[] required

Profile tags

createdAtstring date-time required

Date when the profile was created.

languagestring required

A language or a comma-separated list of languages for the profile. ISO 639-1 language and optionally ISO 3166-1 region code.

storage'local' | 'cloud'
folderIdstring uuid nullable

A unique identifier of the containing folder, or empty (00000000-0000-0000-0000-000000000000) if not in a folder. This will always be empty for locally stored profiles, as only cloud profiles can be added to folders.

Example response

[
  {
    "id": "a7cafbbe-6bc0-4575-8c6e-f1adf391f180",
    "name": "mystic-turtle",
    "tags": [
      "facebook",
      "instagram"
    ],
    "proxy": {
      "extra": {
        "host": "127.0.0.1",
        "port": 9951,
        "id": "username",
        "secret": "password"
      }
    },
    "createdAt": "2020-05-02T03:10:32.2452701+10:00",
    "device": {
      "type": "desktop",
      "name": "Samsung SM-A705FN"
    },
    "os": {
      "family": "windows",
      "version": "10.15.4",
      "platform": "64"
    },
    "browser": {
      "product": "chrome",
      "major": 81,
      "version": "81.0.4044"
    },
    "language": "en-US,en",
    "folderId": "c7aafbbe-b6c0-5475-c66e-1fadf39180f1"
  }
]