> ## 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: Cadences Index

> List or search Salesloft cadences (sequences) by name, owner, tag, group or archived status. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List or search Salesloft cadences (sequences) by name, owner, tag, group or archived status.

> [!NOTE]
>
> Tool ID: `salesloft_cadences_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_cadences_index',
  {
    "ids": [
      123
    ],
    "updated_at": {
      "gt": "example",
      "gte": "example",
      "lt": "example"
    },
    "team_cadence": true
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesloft_cadences_index --input '{
  "ids": [
    123
  ],
  "updated_at": {
    "gt": "example",
    "gte": "example",
    "lt": "example"
  },
  "team_cadence": true
}' --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,
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ]
}
```

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

## Input reference

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

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.ids` | `array` | No | — | IDs of cadences to fetch. If a record can't be found, that record won't be returned and your request will be successful |
| `payload.updated_at` | `object` | No | — | Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision. |
| `payload.team_cadence` | `boolean` | No | — | Filters cadences by whether they are a team cadence or not |
| `payload.shared` | `boolean` | No | — | Filters cadences by whether they are shared |
| `payload.owned_by_guid` | `array` | No | — | Filters cadences by the owner's guid. Multiple owner guids can be applied |
| `payload.people_addable` | `boolean` | No | — | Filters cadences by whether they are able to have people added to them |
| `payload.name` | `array` | No | — | Filters cadences by name |
| `payload.group_ids` | `string` | No | — | Filters by group ids. Also supports group ids passed in as a JSON array string |
| `payload.tag_ids` | `array` | No | — | Filters by tags. |
| `payload.archived` | `boolean` | No | — | Filters by whether the Cadences have been archived. Excluding this field will result in both archived and unarchived Cadences to return. |
| `payload.override_contact_restrictions` | `boolean` | No | — | Filters by whether the Cadences are operational. Excluding this field will result in both operational and standard Cadences to return. |
| `payload.pending_actions_assigned_to` | `array` | No | — | Filters by whether the Cadence has at least one pending cadence action assigned to any of the provided accounts |
| `payload.sort_by` | `string` | No | — | Key to sort on, must be one of: created\_at, updated\_at, name. Defaults to updated\_at |
| `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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Fetches multiple cadence records. The records can be filtered, paged, and sorted according to the respective parameters.",
    "properties": {
      "ids": {
        "type": "array",
        "description": "IDs of cadences to fetch. If a record can't be found, that record won't be returned and your request will be successful",
        "items": {
          "type": "integer"
        }
      },
      "updated_at": {
        "type": "object",
        "description": "Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.",
        "properties": {
          "gt": {
            "type": "string",
            "description": "Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."
          },
          "gte": {
            "type": "string",
            "description": "Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."
          },
          "lt": {
            "type": "string",
            "description": "Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."
          },
          "lte": {
            "type": "string",
            "description": "Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "team_cadence": {
        "type": "boolean",
        "description": "Filters cadences by whether they are a team cadence or not"
      },
      "shared": {
        "type": "boolean",
        "description": "Filters cadences by whether they are shared"
      },
      "owned_by_guid": {
        "type": "array",
        "description": "Filters cadences by the owner's guid. Multiple owner guids can be applied",
        "items": {
          "type": "string"
        }
      },
      "people_addable": {
        "type": "boolean",
        "description": "Filters cadences by whether they are able to have people added to them"
      },
      "name": {
        "type": "array",
        "description": "Filters cadences by name",
        "items": {
          "type": "string"
        }
      },
      "group_ids": {
        "type": "string",
        "description": "Filters by group ids. Also supports group ids passed in as a JSON array string"
      },
      "tag_ids": {
        "type": "array",
        "description": "Filters by tags.",
        "items": {
          "type": "integer"
        }
      },
      "archived": {
        "type": "boolean",
        "description": "Filters by whether the Cadences have been archived. Excluding this field will result in both archived and unarchived Cadences to return."
      },
      "override_contact_restrictions": {
        "type": "boolean",
        "description": "Filters by whether the Cadences are operational. Excluding this field will result in both operational and standard Cadences to return."
      },
      "pending_actions_assigned_to": {
        "type": "array",
        "description": "Filters by whether the Cadence has at least one pending cadence action assigned to any of the provided accounts",
        "items": {
          "type": "string"
        }
      },
      "sort_by": {
        "type": "string",
        "description": "Key to sort on, must be one of: created_at, updated_at, name. Defaults to updated_at"
      },
      "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` | `integer` | No | — | ID of cadence |
| `result.data[].created_at` | `string` | No | — | Datetime of when the cadence was created Format: `date-time`. |
| `result.data[].updated_at` | `string` | No | — | Datetime of when the cadence was last updated Format: `date-time`. |
| `result.data[].archived_at` | `string` | No | — | Datetime of when the cadence was archived, if archived Format: `date-time`. |
| `result.data[].latest_active_date` | `string` | No | — | Date of when the cadence was last used Format: `date`. |
| `result.data[].team_cadence` | `boolean` | No | — | Whether this cadence is a team cadence. A team cadence is created by an admin and can be run by all users |
| `result.data[].shared` | `boolean` | No | — | Whether this cadence is visible to team members (shared) |
| `result.data[].archived` | `boolean` | No | — | Whether this cadence is archived |
| `result.data[].remove_bounces_enabled` | `boolean` | No | — | Whether this cadence is configured to automatically remove people who have bounced |
| `result.data[].remove_replies_enabled` | `boolean` | No | — | Whether this cadence is configured to automatically remove people who have replied |
| `result.data[].opt_out_link_included` | `boolean` | No | — | Whether this cadence is configured to include an opt-out link by default |
| `result.data[].draft` | `boolean` | No | — | Whether this cadence is in draft mode |
| `result.data[].override_contact_restrictions` | `boolean` | No | — | Whether this cadence is an Operational Cadence. An operational cadence is only created by an admin and accounts with the correct permission |
| `result.data[].cadence_framework_id` | `integer` | No | — | ID of the cadence framework used to create steps for the cadence |
| `result.data[].archived_by` | `string` | No | — | Name or email of the user who archived the cadence |
| `result.data[].knowledge_library_document_ids` | `array` | No | — | IDs of knowledge library documents associated with this cadence |
| `result.data[].cadence_function` | `string` | No | — | The use case of the cadence. Possible values are: outbound: Denotes an outbound cadence, typically for sales purposes inbound: Denotes an inbound sales cadence event: Denotes a cadence used for an upcoming event other: Denotes a cadence outside of the standard process |
| `result.data[].name` | `string` | No | — | Cadence name |
| `result.data[].external_identifier` | `string` | No | — | Cadence External ID |
| `result.data[].tags` | `array` | No | — | All tags applied to this cadence |
| `result.data[].current_state` | `string` | No | — | The state of the Cadence. Read Only. Valid states are: draft, pending\_review, active, archived, expired, deleted |
| `result.data[].creator` | `object` | No | — | User that created this cadence |
| `result.data[].creator.id` | `integer` | No | — | — |
| `result.data[].creator._href` | `string` | No | — | — |
| `result.data[].owner` | `object` | No | — | User that is marked as the owner of this cadence |
| `result.data[].owner.id` | `integer` | No | — | — |
| `result.data[].owner._href` | `string` | No | — | — |
| `result.data[].bounced_stage` | `object` | No | — | Stage set when person on cadence bounces |
| `result.data[].bounced_stage.id` | `integer` | No | — | — |
| `result.data[].bounced_stage._href` | `string` | No | — | — |
| `result.data[].replied_stage` | `object` | No | — | Stage set when person on cadence replies |
| `result.data[].replied_stage.id` | `integer` | No | — | — |
| `result.data[].replied_stage._href` | `string` | No | — | — |
| `result.data[].added_stage` | `object` | No | — | Stage set when person is added to cadence |
| `result.data[].added_stage.id` | `integer` | No | — | — |
| `result.data[].added_stage._href` | `string` | No | — | — |
| `result.data[].finished_stage` | `object` | No | — | Stage set when person is finished with cadence |
| `result.data[].finished_stage.id` | `integer` | No | — | — |
| `result.data[].finished_stage._href` | `string` | No | — | — |
| `result.data[].cadence_priority` | `object` | No | — | Priority of the cadence |
| `result.data[].cadence_priority.id` | `integer` | No | — | — |
| `result.data[].cadence_priority._href` | `string` | No | — | — |
| `result.data[].groups` | `array` | No | — | Groups to which this cadence is assigned, if any |
| `result.data[].groups[].id` | `integer` | No | — | — |
| `result.data[].groups[]._href` | `string` | No | — | — |
| `result.data[].counts` | `object` | No | — | — |
| `result.data[].counts.cadence_people` | `integer` | No | — | The number of people that have ever been added to the cadence |
| `result.data[].counts.people_acted_on_count` | `integer` | No | — | The number of people that have been skipped, scheduled, or advanced in a cadence |
| `result.data[].counts.target_daily_people` | `integer` | No | — | The user defined target for number of people to add to the cadence each day |

The table shows the first 50 fields. Expand the raw schema below for every field.

<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 cadence"
            },
            "created_at": {
              "type": "string",
              "description": "Datetime of when the cadence was created",
              "format": "date-time"
            },
            "updated_at": {
              "type": "string",
              "description": "Datetime of when the cadence was last updated",
              "format": "date-time"
            },
            "archived_at": {
              "type": "string",
              "description": "Datetime of when the cadence was archived, if archived",
              "format": "date-time"
            },
            "latest_active_date": {
              "type": "string",
              "description": "Date of when the cadence was last used",
              "format": "date"
            },
            "team_cadence": {
              "type": "boolean",
              "description": "Whether this cadence is a team cadence. A team cadence is created by an admin and can be run by all users"
            },
            "shared": {
              "type": "boolean",
              "description": "Whether this cadence is visible to team members (shared)"
            },
            "archived": {
              "type": "boolean",
              "description": "Whether this cadence is archived"
            },
            "remove_bounces_enabled": {
              "type": "boolean",
              "description": "Whether this cadence is configured to automatically remove people who have bounced"
            },
            "remove_replies_enabled": {
              "type": "boolean",
              "description": "Whether this cadence is configured to automatically remove people who have replied"
            },
            "opt_out_link_included": {
              "type": "boolean",
              "description": "Whether this cadence is configured to include an opt-out link by default"
            },
            "draft": {
              "type": "boolean",
              "description": "Whether this cadence is in draft mode"
            },
            "override_contact_restrictions": {
              "type": "boolean",
              "description": "Whether this cadence is an Operational Cadence. An operational cadence is only created by an admin and accounts with the correct permission"
            },
            "cadence_framework_id": {
              "type": "integer",
              "description": "ID of the cadence framework used to create steps for the cadence"
            },
            "archived_by": {
              "type": "string",
              "description": "Name or email of the user who archived the cadence"
            },
            "knowledge_library_document_ids": {
              "type": "array",
              "description": "IDs of knowledge library documents associated with this cadence",
              "items": {
                "type": "integer"
              }
            },
            "cadence_function": {
              "type": "string",
              "description": "The use case of the cadence. Possible values are: outbound: Denotes an outbound cadence, typically for sales purposes inbound: Denotes an inbound sales cadence event: Denotes a cadence used for an upcoming event other: Denotes a cadence outside of the standard process"
            },
            "name": {
              "type": "string",
              "description": "Cadence name"
            },
            "external_identifier": {
              "type": "string",
              "description": "Cadence External ID"
            },
            "tags": {
              "type": "array",
              "description": "All tags applied to this cadence",
              "items": {
                "type": "string"
              }
            },
            "current_state": {
              "type": "string",
              "description": "The state of the Cadence. Read Only. Valid states are: draft, pending_review, active, archived, expired, deleted"
            },
            "creator": {
              "type": "object",
              "description": "User that created this cadence",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "owner": {
              "type": "object",
              "description": "User that is marked as the owner of this cadence",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "bounced_stage": {
              "type": "object",
              "description": "Stage set when person on cadence bounces",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "replied_stage": {
              "type": "object",
              "description": "Stage set when person on cadence replies",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "added_stage": {
              "type": "object",
              "description": "Stage set when person is added to cadence",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "finished_stage": {
              "type": "object",
              "description": "Stage set when person is finished with cadence",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "cadence_priority": {
              "type": "object",
              "description": "Priority of the cadence",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "groups": {
              "type": "array",
              "description": "Groups to which this cadence is assigned, if any",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "_href": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              }
            },
            "counts": {
              "type": "object",
              "properties": {
                "cadence_people": {
                  "type": "integer",
                  "description": "The number of people that have ever been added to the cadence"
                },
                "people_acted_on_count": {
                  "type": "integer",
                  "description": "The number of people that have been skipped, scheduled, or advanced in a cadence"
                },
                "target_daily_people": {
                  "type": "integer",
                  "description": "The user defined target for number of people to add to the cadence each day"
                },
                "opportunities_created": {
                  "type": "integer",
                  "description": "The number of opportunities created and attributed to the cadence"
                },
                "meetings_booked": {
                  "type": "integer",
                  "description": "The number of meetings booked and attributed to the cadence"
                }
              },
              "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.