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

# Salesloft: Groups Index

> List the user groups in your Salesloft team. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the user groups in your Salesloft team.

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

## 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(
  'salesloft_groups_index',
  {
    "ids": [
      123
    ],
    "sort_by": "example",
    "sort_direction": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesloft_groups_index --input '{
  "ids": [
    123
  ],
  "sort_by": "example",
  "sort_direction": "example"
}' --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": [
    {
      "id": 123,
      "name": "Example",
      "parent_id": 123
    }
  ]
}
```

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

## Input reference

Fetches multiple group records. The records can be filtered, and sorted according to the respective parameters.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.ids` | `array` | No | — | IDs of groups to fetch. |
| `payload.sort_by` | `string` | No | — | Key to sort on, must be one of: created\_at, updated\_at. Defaults to updated\_at |
| `payload.sort_direction` | `string` | No | — | Direction to sort in, must be one of: ASC, DESC. Defaults to DESC |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Fetches multiple group records. The records can be filtered, and sorted according to the respective parameters.",
    "properties": {
      "ids": {
        "type": "array",
        "description": "IDs of groups to fetch.",
        "items": {
          "type": "integer"
        }
      },
      "sort_by": {
        "type": "string",
        "description": "Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at"
      },
      "sort_direction": {
        "type": "string",
        "description": "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `array` | Yes | — | Provider response payload. |
| `result.data[].id` | `integer` | No | — | ID of the Group |
| `result.data[].name` | `string` | No | — | Name of the Group |
| `result.data[].parent_id` | `integer` | No | — | ID of the parent Group |
| `result.data[].accessible_groups` | `array` | No | — | Groups accessible if any |
| `result.data[].accessible_groups[].id` | `integer` | No | — | — |
| `result.data[].accessible_groups[]._href` | `string` | No | — | — |
| `result.data[].parent_groups` | `array` | No | — | Parent groups if any |
| `result.data[].parent_groups[].id` | `integer` | No | — | — |
| `result.data[].parent_groups[]._href` | `string` | 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": "array",
        "description": "Provider response payload.",
        "items": {
          "type": "object",
          "description": "Provider response payload.",
          "properties": {
            "id": {
              "type": "integer",
              "description": "ID of the Group"
            },
            "name": {
              "type": "string",
              "description": "Name of the Group"
            },
            "parent_id": {
              "type": "integer",
              "description": "ID of the parent Group"
            },
            "accessible_groups": {
              "type": "array",
              "description": "Groups accessible if any",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "_href": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              }
            },
            "parent_groups": {
              "type": "array",
              "description": "Parent groups if any",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "_href": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              }
            }
          },
          "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

* [Salesloft provider guide](https://deepline.com/docs/providers/salesloft/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.