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

# Attention List Users: Inputs, Cost & CLI Example

> List Users. Attention Attention List Users docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=attention_list_users:{}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                     | Type      | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ----------- |
| `payload.filter`         | `object`  | No       |         |             |
| `payload.teamUUID`       | `string`  | No       |         |             |
| `payload.includeDeleted` | `boolean` | No       | `false` |             |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Returns a list of users, you can also filter by id, email and teamUUID",
    "properties": {
      "filter": {
        "type": "object",
        "properties": {
          "id": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "email": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "teamUUID": {
        "type": "string"
      },
      "includeDeleted": {
        "type": "boolean",
        "default": false
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "uuid": {
                  "type": "string",
                  "description": "The unique identifier of the user."
                },
                "email": {
                  "type": "string",
                  "description": "The email address of the user."
                },
                "firstName": {
                  "type": "string",
                  "description": "The first name of the user."
                },
                "lastName": {
                  "type": "string",
                  "description": "The last name of the user."
                },
                "createdAt": {
                  "type": "string",
                  "description": "The date and time the user was created."
                },
                "deletedAt": {
                  "type": "string",
                  "description": "The date and time the user was deactivated."
                },
                "transcriptLang": {
                  "type": "string",
                  "description": "The preferred transcript language for the user."
                },
                "joinOutsideHostMeetings": {
                  "type": "boolean",
                  "description": "Indicates if the user can join meetings outside their host organization."
                },
                "realTimeCapabilities": {
                  "type": "boolean",
                  "description": "Indicates if the user has real-time transcription capabilities."
                },
                "settings": {
                  "type": "object",
                  "properties": {
                    "realTimeCapabilitiesOFF": {
                      "type": "boolean"
                    },
                    "autoCalculateCRMFields": {
                      "type": "boolean"
                    },
                    "joinWhenIAmHostAndAlone": {
                      "type": "boolean"
                    },
                    "joinWhenIAmHostWithPeers": {
                      "type": "boolean"
                    },
                    "joinWhenPeerIsHost": {
                      "type": "boolean"
                    },
                    "joinWhenUnlicensedPeerIsHost": {
                      "type": "boolean"
                    },
                    "dealsEnabled": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                },
                "botName": {
                  "type": "string",
                  "description": "The name of the bot associated with the user."
                },
                "botImageURL": {
                  "type": "string",
                  "description": "The URL of the bot's profile image."
                },
                "primaryTeamUUID": {
                  "type": "string",
                  "description": "The UUID of the user's primary team."
                },
                "organizationRoleUUID": {
                  "type": "string",
                  "description": "The UUID of the user's role in the organization."
                },
                "roles": {
                  "type": "array",
                  "description": "A list of roles assigned to the user.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "uuid": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "showReferralScreen": {
                  "type": "boolean",
                  "description": "Whether the user is shown a referral screen."
                },
                "seatType": {
                  "type": "string",
                  "description": "The type of seat assigned to the user."
                },
                "teams": {
                  "type": "array",
                  "description": "A list of teams assigned to the user.",
                  "items": {
                    "type": "object",
                    "description": "Represents a team in the system with its properties and hierarchical structure",
                    "properties": {
                      "uuid": {
                        "type": "string",
                        "description": "Unique identifier of the team"
                      },
                      "name": {
                        "type": "string",
                        "description": "Name of the team"
                      },
                      "phrases": {
                        "type": "array",
                        "description": "List of keywords or phrases associated with the team",
                        "items": {
                          "type": "string"
                        }
                      },
                      "slackConnection": {
                        "type": "object",
                        "description": "Represents the Slack integration details for a team",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Slack connection identifier"
                          },
                          "info": {
                            "type": "object",
                            "description": "Information about a connected Slack team",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Slack team identifier"
                              },
                              "name": {
                                "type": "string",
                                "description": "Name of the Slack team"
                              }
                            },
                            "additionalProperties": false
                          }
                        },
                        "additionalProperties": false
                      },
                      "domain": {
                        "type": "string",
                        "description": "Domain associated with the team"
                      },
                      "organizerJoinInternalMeetings": {
                        "type": "boolean",
                        "description": "Whether team organizers can join internal meetings"
                      },
                      "consentEmailEnabled": {
                        "type": "boolean",
                        "description": "Whether email consent is enabled for the team"
                      },
                      "parentTeamUUID": {
                        "type": "string",
                        "description": "UUID of the parent team if this team is part of a hierarchy"
                      },
                      "organizationUUID": {
                        "type": "string",
                        "description": "UUID of the organization this team belongs to"
                      },
                      "children": {
                        "type": "array",
                        "description": "List of child teams if this team has a hierarchical structure",
                        "items": {
                          "type": "object",
                          "description": "Recursive OpenAPI schema reference #/components/schemas/Team.",
                          "additionalProperties": true
                        }
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string"
              },
              "related": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute attention_list_users --payload '{}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.
