> ## 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: Cadence Collections Index

> List or search Salesloft cadence collections (folders of cadences) by name or type. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List or search Salesloft cadence collections (folders of cadences) by name or type.

> [!NOTE]
>
> Tool ID: `salesloft_cadence_collections_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_cadence_collections_index',
  {
    "collection_type": "example",
    "search": "software companies hiring engineers",
    "sort_by": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesloft_cadence_collections_index --input '{
  "collection_type": "example",
  "search": "software companies hiring engineers",
  "sort_by": "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",
      "description": "Example description"
    }
  ]
}
```

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

## Input reference

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

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.collection_type` | `string` | No | — | Filter by collection type: 'team' or 'personal' |
| `payload.search` | `string` | No | — | Filters cadence collections by name |
| `payload.sort_by` | `string` | No | — | Key to sort on, must be one of: name. When omitted, results are ordered by starred collections first, then most recently created. |
| `payload.sort_direction` | `string` | No | — | Direction to sort in, must be one of: ASC, DESC. Defaults to ASC. Only applies when sort\_by is provided. Otherwise it is ignored. |
| `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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Fetches multiple cadence collection records. The records can be filtered, sorted, and paged according to the respective parameters.",
    "properties": {
      "collection_type": {
        "type": "string",
        "description": "Filter by collection type: 'team' or 'personal'"
      },
      "search": {
        "type": "string",
        "description": "Filters cadence collections by name"
      },
      "sort_by": {
        "type": "string",
        "description": "Key to sort on, must be one of: name. When omitted, results are ordered by starred collections first, then most recently created."
      },
      "sort_direction": {
        "type": "string",
        "description": "Direction to sort in, must be one of: ASC, DESC. Defaults to ASC. Only applies when sort_by is provided; otherwise it is ignored."
      },
      "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` | `integer` | No | — | ID of the cadence collection |
| `result.data[].name` | `string` | No | — | Name of the cadence collection |
| `result.data[].description` | `string` | No | — | Description of the cadence collection |
| `result.data[].account_id` | `integer` | No | — | ID of the account that owns the collection |
| `result.data[].team_collection` | `boolean` | No | — | Whether this is a team collection |
| `result.data[].starred` | `boolean` | No | — | Whether this collection is starred for the team |
| `result.data[].bounced_stage_setting_id` | `integer` | No | — | ID of the bounced stage setting |
| `result.data[].replied_stage_setting_id` | `integer` | No | — | ID of the replied stage setting |
| `result.data[].added_stage_setting_id` | `integer` | No | — | ID of the added stage setting |
| `result.data[].finished_stage_setting_id` | `integer` | No | — | ID of the finished stage setting |
| `result.data[].cadence_priority_id` | `integer` | No | — | ID of the cadence priority |
| `result.data[].created_at` | `string` | No | — | Datetime of when the collection was created Format: `date-time`. |
| `result.data[].updated_at` | `string` | No | — | Datetime of when the collection was last updated Format: `date-time`. |
| `result.data[].target_daily_people` | `integer` | No | — | Target daily people for the collection |
| `result.data[].shared` | `boolean` | No | — | Whether the collection is shared |
| `result.data[].remove_replied` | `boolean` | No | — | Whether to remove replied people |
| `result.data[].remove_bounced` | `boolean` | No | — | Whether to remove bounced people |
| `result.data[].remove_people_when_meeting_booked` | `boolean` | No | — | Whether to remove people when a meeting is booked |
| `result.data[].reschedule_from_pause_enabled` | `boolean` | No | — | Whether reschedule from pause is enabled |
| `result.data[].email_footer_id` | `integer` | No | — | ID of the email footer |
| `result.data[].cadence_level_throttling_enabled` | `boolean` | No | — | Whether cadence-level throttling is enabled |
| `result.data[].override_max_daily_starts` | `integer` | No | — | Override maximum daily starts |
| `result.data[].override_max_active_contacts` | `integer` | No | — | Override maximum active contacts |
| `result.data[].has_opt_out_link` | `boolean` | No | — | Whether the collection has an opt-out link |
| `result.data[].tags` | `array` | No | — | Tags associated with the cadence collection |
| `result.data[].group_ids` | `array` | No | — | IDs of groups to which this cadence collection is assigned, if any |
| `result.data[].external_identifier` | `string` | No | — | External identifier for the cadence collection |
| `result.data[].cadence_function` | `string` | No | — | The function of the cadence collection. Possible values are: outbound, inbound, event, renewal, nurture, other |
| `result.data[].cadences_count` | `integer` | No | — | Number of active cadences in this collection |
| `result.data[].total_people_count` | `integer` | No | — | Total number of people across active cadences in this collection |
| `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 cadence collection"
            },
            "name": {
              "type": "string",
              "description": "Name of the cadence collection"
            },
            "description": {
              "type": "string",
              "description": "Description of the cadence collection"
            },
            "account_id": {
              "type": "integer",
              "description": "ID of the account that owns the collection"
            },
            "team_collection": {
              "type": "boolean",
              "description": "Whether this is a team collection"
            },
            "starred": {
              "type": "boolean",
              "description": "Whether this collection is starred for the team"
            },
            "bounced_stage_setting_id": {
              "type": "integer",
              "description": "ID of the bounced stage setting"
            },
            "replied_stage_setting_id": {
              "type": "integer",
              "description": "ID of the replied stage setting"
            },
            "added_stage_setting_id": {
              "type": "integer",
              "description": "ID of the added stage setting"
            },
            "finished_stage_setting_id": {
              "type": "integer",
              "description": "ID of the finished stage setting"
            },
            "cadence_priority_id": {
              "type": "integer",
              "description": "ID of the cadence priority"
            },
            "created_at": {
              "type": "string",
              "description": "Datetime of when the collection was created",
              "format": "date-time"
            },
            "updated_at": {
              "type": "string",
              "description": "Datetime of when the collection was last updated",
              "format": "date-time"
            },
            "target_daily_people": {
              "type": "integer",
              "description": "Target daily people for the collection"
            },
            "shared": {
              "type": "boolean",
              "description": "Whether the collection is shared"
            },
            "remove_replied": {
              "type": "boolean",
              "description": "Whether to remove replied people"
            },
            "remove_bounced": {
              "type": "boolean",
              "description": "Whether to remove bounced people"
            },
            "remove_people_when_meeting_booked": {
              "type": "boolean",
              "description": "Whether to remove people when a meeting is booked"
            },
            "reschedule_from_pause_enabled": {
              "type": "boolean",
              "description": "Whether reschedule from pause is enabled"
            },
            "email_footer_id": {
              "type": "integer",
              "description": "ID of the email footer"
            },
            "cadence_level_throttling_enabled": {
              "type": "boolean",
              "description": "Whether cadence-level throttling is enabled"
            },
            "override_max_daily_starts": {
              "type": "integer",
              "description": "Override maximum daily starts"
            },
            "override_max_active_contacts": {
              "type": "integer",
              "description": "Override maximum active contacts"
            },
            "has_opt_out_link": {
              "type": "boolean",
              "description": "Whether the collection has an opt-out link"
            },
            "tags": {
              "type": "array",
              "description": "Tags associated with the cadence collection",
              "items": {
                "type": "string"
              }
            },
            "group_ids": {
              "type": "array",
              "description": "IDs of groups to which this cadence collection is assigned, if any",
              "items": {
                "type": "integer"
              }
            },
            "external_identifier": {
              "type": "string",
              "description": "External identifier for the cadence collection"
            },
            "cadence_function": {
              "type": "string",
              "description": "The function of the cadence collection. Possible values are: outbound, inbound, event, renewal, nurture, other"
            },
            "cadences_count": {
              "type": "integer",
              "description": "Number of active cadences in this collection"
            },
            "total_people_count": {
              "type": "integer",
              "description": "Total number of people across active cadences in this collection"
            }
          },
          "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.