> ## 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: Custom Roles Index

> List custom roles. Salesloft Custom Roles Index reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

List custom roles.

<Info>
  Tool ID: `salesloft_custom_roles_index`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'salesloft_custom_roles_index',
  {
    "ids": [
      "id_123"
    ],
    "sort_by": "example",
    "sort_direction": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute salesloft_custom_roles_index --input '{
  "ids": [
    "id_123"
  ],
  "sort_by": "example",
  "sort_direction": "example"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": [
    {
      "id": "id_123",
      "name": "Example",
      "permissions": [
        "example"
      ]
    }
  ]
}
```

Use `deepline tools get salesloft_custom_roles_index --json` for the latest machine-readable contract.

## Input reference

Fetches multiple custom role records. The records can be filtered, and sorted according to the respective parameters. A custom role is any role that is not Admin or User.

| Name                            | Type      | Required | Default | Details                                                                                                                               |
| ------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.ids`                   | `array`   | No       | —       | IDs of roles to fetch.                                                                                                                |
| `payload.sort_by`               | `string`  | No       | —       | Key to sort on, must be one of: id, name. Defaults to id                                                                              |
| `payload.sort_direction`        | `string`  | No       | —       | Direction to sort in, must be one of: ASC, DESC. Defaults to DESC                                                                     |
| `payload.per_page`              | `integer` | No       | —       | How many records to show per page in the range \[1, 100]. Defaults to 25                                                              |
| `payload.page`                  | `integer` | No       | —       | The current page to fetch results from. Defaults to 1                                                                                 |
| `payload.include_paging_counts` | `boolean` | No       | —       | Whether to include total\_pages and total\_count in the metadata. Defaults to false                                                   |
| `payload.limit_paging_counts`   | `boolean` | No       | —       | Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total\_count and total\_pages data |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Fetches multiple custom role records. The records can be filtered, and sorted according to the respective parameters. A custom role is any role that is not Admin or User.",
    "properties": {
      "ids": {
        "type": "array",
        "description": "IDs of roles to fetch.",
        "items": {
          "type": "string"
        }
      },
      "sort_by": {
        "type": "string",
        "description": "Key to sort on, must be one of: id, name. Defaults to id"
      },
      "sort_direction": {
        "type": "string",
        "description": "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
      },
      "per_page": {
        "type": "integer",
        "description": "How many records to show per page in the range [1, 100]. Defaults to 25"
      },
      "page": {
        "type": "integer",
        "description": "The current page to fetch results from. Defaults to 1"
      },
      "include_paging_counts": {
        "type": "boolean",
        "description": "Whether to include total_pages and total_count in the metadata. Defaults to false"
      },
      "limit_paging_counts": {
        "type": "boolean",
        "description": "Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data"
      }
    },
    "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`          | `string` | No       | —       | ID of the custom role                            |
| `result.data[].name`        | `string` | No       | —       | Name of the custom role                          |
| `result.data[].permissions` | `array`  | No       | —       | List of permissions assigned to this custom role |
| `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": "array",
        "description": "Provider response payload.",
        "items": {
          "type": "object",
          "description": "Provider response payload.",
          "properties": {
            "id": {
              "type": "string",
              "description": "ID of the custom role"
            },
            "name": {
              "type": "string",
              "description": "Name of the custom role"
            },
            "permissions": {
              "type": "array",
              "description": "List of permissions assigned to this custom role",
              "items": {
                "type": "string"
              }
            }
          },
          "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](/docs/providers/salesloft/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)