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

# Users SDK Reference

> SDK reference for the Users API, available in Node.js and Python.

## Users

### List Users

Returns all users in the current workspace, including their team memberships and workspace roles. Requires a Management Key with user permissions or an authenticated workspace admin session. Standard API keys are not supported.

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.users.list()

    # Handle response
    print(res)

```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.users.list();

  console.log(result);
}

run();
```

**Response**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "users": [{  # optional
        "id": Optional[str],
        "account_id": Optional[str],
        "email": Optional[str],
        "display_name": Optional[str],
        "logo_url": Optional[str],
        "team_ids": List[str],  # optional
        "roles": List[str],  # optional
        "last_activity": str,  # optional
        "invitation_data": {  # optional
            "email": Optional[str],
            "display_name": Optional[str],
        },
    }],
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  users?: {
    id?: string;
    accountId?: string;
    email?: string;
    displayName?: string;
    logoUrl?: string;
    teamIds?: string[];
    roles?: string[];
    lastActivity?: Date;
    invitationData?: {
      email?: string;
      displayName?: string;
    };
  }[];
}
```

### Retrieve a User

Retrieves one workspace user by workspace-user ID. Requires a Management Key with user permissions or an authenticated workspace admin session. Standard API keys are not supported.

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.users.get(user_id="<id>")

    # Handle response
    print(res)

```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.users.get({
    userId: "<id>",
  });

  console.log(result);
}

run();
```

**Parameters**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "user_id": str,  # required
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  userId: string;  // required
}
```

**Response**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "user": {  # optional
        "id": Optional[str],
        "account_id": Optional[str],
        "email": Optional[str],
        "display_name": Optional[str],
        "logo_url": Optional[str],
        "team_ids": List[str],  # optional
        "roles": List[str],  # optional
        "last_activity": str,  # optional
        "invitation_data": {  # optional
            "email": Optional[str],
            "display_name": Optional[str],
        },
    },
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  user?: {
    id?: string;
    accountId?: string;
    email?: string;
    displayName?: string;
    logoUrl?: string;
    teamIds?: string[];
    roles?: string[];
    lastActivity?: Date;
    invitationData?: {
      email?: string;
      displayName?: string;
    };
  };
}
```

### Delete a User

Removes a user from the current workspace, refreshes membership state, and revokes API keys owned by that workspace user. Requires a Management Key with user permissions or an authenticated workspace admin session. Standard API keys are not supported.

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.users.delete(user_id="<id>")

    # Handle response
    print(res)

```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.users.delete({
    userId: "<id>",
  });

  console.log(result);
}

run();
```

**Parameters**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "user_id": str,  # required
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  userId: string;  // required
}
```

### Update a User

Updates a user's last-activity timestamp and/or workspace role. Omitted fields remain unchanged. Requires a Management Key with user permissions or an authenticated workspace admin session. Standard API keys are not supported.

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from orq_ai_sdk import Orq
from orq_ai_sdk.utils import parse_datetime
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.users.update(user_id="<id>", last_activity=parse_datetime("2024-01-01T00:00:00Z"))

    # Handle response
    print(res)

```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.users.update({
    userId: "<id>",
    updateUserRequest: {
      lastActivity: "<value>",
    },
  });

  console.log(result);
}

run();
```

**Parameters**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "user_id": str,  # required
    "last_activity": str,  # optional
    "role": Optional[str],
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  userId: string;  // required
  updateUserRequest: {  // required
    lastActivity?: Date;
    role?: string;
  };
}
```

**Response**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "user": {  # optional
        "id": Optional[str],
        "account_id": Optional[str],
        "email": Optional[str],
        "display_name": Optional[str],
        "logo_url": Optional[str],
        "team_ids": List[str],  # optional
        "roles": List[str],  # optional
        "last_activity": str,  # optional
        "invitation_data": {  # optional
            "email": Optional[str],
            "display_name": Optional[str],
        },
    },
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  user?: {
    id?: string;
    accountId?: string;
    email?: string;
    displayName?: string;
    logoUrl?: string;
    teamIds?: string[];
    roles?: string[];
    lastActivity?: Date;
    invitationData?: {
      email?: string;
      displayName?: string;
    };
  };
}
```

### Create a User

Creates accounts when necessary, adds each user to the current workspace and specified team, assigns the workspace role, and sends the welcome email for newly created accounts. Requires a Management Key with user permissions or an authenticated workspace admin session. Standard API keys are not supported.

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.users.create(team_id="<id>", emails=["<value>"])

    # Handle response
    print(res)

```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.users.create({
    teamId: "<id>",
    createUsersRequest: {
      emails: ["<value>"],
    },
  });

  console.log(result);
}

run();
```

**Parameters**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "team_id": str,  # required
    "emails": List[str],  # optional
    "roles": List[str],  # optional
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  teamId: string;  // required
  createUsersRequest: {  // required
    emails?: string[];
    roles?: string[];
  };
}
```

**Response**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "users": [{  # optional
        "id": Optional[str],
        "account_id": Optional[str],
        "email": Optional[str],
        "display_name": Optional[str],
        "logo_url": Optional[str],
        "team_ids": List[str],  # optional
        "roles": List[str],  # optional
        "last_activity": str,  # optional
        "invitation_data": {  # optional
            "email": Optional[str],
            "display_name": Optional[str],
        },
    }],
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  users?: {
    id?: string;
    accountId?: string;
    email?: string;
    displayName?: string;
    logoUrl?: string;
    teamIds?: string[];
    roles?: string[];
    lastActivity?: Date;
    invitationData?: {
      email?: string;
      displayName?: string;
    };
  }[];
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.