Get virtual user.

GET

/v1/virtual-users/{identity_id}

const url = 'https://app.everruns.com/api/v1/virtual-users/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.everruns.com/api/v1/virtual-users/example

Parameters

Path Parameters

identity_id

required

string

Responses

200

Success

application/json

Organization-scoped runtime account with its own profile and connections.

object

archived_at

Archive timestamp.

string | null format: date-time

avatar_url

Optional avatar URL for UI surfaces.

string | null

created_at

required

Creation timestamp.

string format: date-time

deleted_at

Delete timestamp.

string | null format: date-time

description

Optional description shown in management UI.

string | null

effective_owner

One of:

object
null

Effective human owner summary derived from the principal lineage.

object

required

string

kind

required

Class of principal that can hold permissions or own resources. system is reserved for platform-internal callers and is never minted via the public API.

string

Allowed values: user virtual_user system

metadata

subject_id

string | null format: uuid

required

External identifier (identity_<32-hex>). Shown as id in API.

string

locale

Default locale for unattended runs.

string | null

name

required

Display name used when the identity acts autonomously.

string

organization_id

required

Organization that owns the runtime account.

string

principal

One of:

object
null

Principal row representing this identity as a durable owner/executor.

object

required

string

kind

required

Class of principal that can hold permissions or own resources. system is reserved for platform-internal callers and is never minted via the public API.

string

Allowed values: user virtual_user system

metadata

subject_id

string | null format: uuid

status

required

Lifecycle status.

string

Allowed values: active archived deleted

timezone

Default timezone for unattended runs.

string | null

updated_at

required

Last update timestamp.

string format: date-time

usage

required

Immutable runtime account purpose.

string

Allowed values: end_user service

Example

{
  "effective_owner": {
    "id": "principal_01933b5a000070008000000000000001",
    "kind": "user"
  },
  "id": "identity_01933b5a000070008000000000000001",
  "organization_id": "org_example",
  "principal": {
    "id": "principal_01933b5a000070008000000000000001",
    "kind": "user"
  },
  "status": "active",
  "usage": "end_user"
}

401

Authentication required

403

Permission denied