> ## 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.

# Fireflies.ai: Fireflies User Groups

> List the user groups in your Fireflies team, optionally only the ones you belong to. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the user groups in your Fireflies team, optionally only the ones you belong to.

> [!NOTE]
>
> Tool ID: `fireflies_user_groups`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'fireflies_user_groups',
  {
    "mine": false
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute fireflies_user_groups --input '{
  "mine": false
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": {
      "user_groups": [
        {
          "id": "id_123",
          "name": "Example",
          "handle": "example"
        }
      ]
    }
  }
}
```

Use `deepline describe fireflies_user_groups --json` for the latest machine-readable contract.

## Input reference

Read user groups, optionally limited to groups containing the authenticated user.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.mine` | `boolean` | No | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Read user groups, optionally limited to groups containing the authenticated user.",
    "properties": {
      "mine": {
        "type": [
          "boolean",
          "null"
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `object` | Yes | — | — |
| `result.data.data.user_groups` | `array \| null` | Yes | — | — |
| `result.data.data.user_groups[].id` | `string` | Yes | — | — |
| `result.data.data.user_groups[].name` | `string` | Yes | — | — |
| `result.data.data.user_groups[].handle` | `string` | Yes | — | — |
| `result.data.data.user_groups[].members` | `array \| null` | No | — | — |
| `result.data.data.user_groups[].members[].user_id` | `string` | Yes | — | — |
| `result.data.data.user_groups[].members[].first_name` | `string` | Yes | — | — |
| `result.data.data.user_groups[].members[].last_name` | `string` | Yes | — | — |
| `result.data.data.user_groups[].members[].email` | `string` | Yes | — | Format: `email`. |
| `result.data.errors` | `array` | No | — | — |
| `result.data.errors[].message` | `string` | Yes | — | — |
| `result.data.errors[].extensions` | `record` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "user_groups": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "handle": {
                      "type": "string"
                    },
                    "members": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "user_id": {
                            "type": "string"
                          },
                          "first_name": {
                            "type": "string"
                          },
                          "last_name": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string",
                            "format": "email"
                          }
                        },
                        "required": [
                          "user_id",
                          "first_name",
                          "last_name",
                          "email"
                        ],
                        "additionalProperties": false
                      }
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "handle"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "user_groups"
            ],
            "additionalProperties": false
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string"
                },
                "extensions": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "required": [
                "message"
              ],
              "additionalProperties": true
            }
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Fireflies.ai provider guide](https://deepline.com/docs/providers/fireflies/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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