> ## 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 Memberships Index

> List the people in Salesloft cadences, with their current step and status, filtered by person or cadence. Includes SDK V2 examples, schemas, and cost.

List the people in Salesloft cadences, with their current step and status, filtered by person or cadence.

> [!NOTE]
>
> Tool ID: `salesloft_cadence_memberships_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_memberships_index',
  {
    "ids": [
      123
    ],
    "person_id": 123,
    "cadence_id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesloft_cadence_memberships_index --input '{
  "ids": [
    123
  ],
  "person_id": 123,
  "cadence_id": 123
}' --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,
      "added_at": "2026-01-15T12:00:00Z",
      "created_at": "2026-01-15T12:00:00Z"
    }
  ]
}
```

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

## Input reference

Fetches multiple cadence membership records. The records can be filtered, paged, and sorted according to the respective parameters. A cadence membership is the association between a person and their current and historical time on a cadence. Cadence membership records are mutable and change over time. If a person is added to a cadence and re-added to the same cadence in the future, there is a single membership record.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.ids` | `array` | No | — | IDs of cadence memberships to fetch. If a record can't be found, that record won't be returned and your request will be successful |
| `payload.person_id` | `integer` | No | — | ID of the person to find cadence memberships for |
| `payload.cadence_id` | `integer` | No | — | ID of the cadence to find cadence memberships for |
| `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.currently_on_cadence` | `boolean` | No | — | If true, return only cadence memberships for people currently on cadences. If false, return cadence memberships for people who have been removed from or have completed a cadence. |
| `payload.sort_by` | `string` | No | — | Key to sort on, must be one of: added\_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 |
| `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 membership records. The records can be filtered, paged, and sorted according to the respective parameters. A cadence membership is the association between a person and their current and historical time on a cadence. Cadence membership records are mutable and change over time. If a person is added to a cadence and re-added to the same cadence in the future, there is a single membership record.",
    "properties": {
      "ids": {
        "type": "array",
        "description": "IDs of cadence memberships to fetch. If a record can't be found, that record won't be returned and your request will be successful",
        "items": {
          "type": "integer"
        }
      },
      "person_id": {
        "type": "integer",
        "description": "ID of the person to find cadence memberships for"
      },
      "cadence_id": {
        "type": "integer",
        "description": "ID of the cadence to find cadence memberships for"
      },
      "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
      },
      "currently_on_cadence": {
        "type": "boolean",
        "description": "If true, return only cadence memberships for people currently on cadences. If false, return cadence memberships for people who have been removed from or have completed a cadence."
      },
      "sort_by": {
        "type": "string",
        "description": "Key to sort on, must be one of: added_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"
      },
      "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 | — | Cadence membership ID |
| `result.data[].added_at` | `string` | No | — | Datetime of when the person was last added to this cadence Format: `date-time`. |
| `result.data[].created_at` | `string` | No | — | Datetime of when the person was first added to this cadence Format: `date-time`. |
| `result.data[].updated_at` | `string` | No | — | Datetime of when the record was last updated Format: `date-time`. |
| `result.data[].person_deleted` | `boolean` | No | — | Whether the associated person has since been deleted |
| `result.data[].currently_on_cadence` | `boolean` | No | — | Whether the person is currently on the cadence |
| `result.data[].current_state` | `string` | No | — | The current state of the person on the cadence. Possible values are: processing: The person is being processed on a cadence. Cadence-related changes cannot be made at this time staged: The person is waiting for the first step in the cadence to occur active: The cadence has begun processing this person and is still in the process, but idle scheduled: The cadence has begun processing this person and is still in the process, with an activity scheduled to occur pending: The person is waiting to be See the live schema for the complete constraint. |
| `result.data[].cadence` | `object` | No | — | The cadence that the person is on |
| `result.data[].cadence.id` | `integer` | No | — | — |
| `result.data[].cadence._href` | `string` | No | — | — |
| `result.data[].step` | `object` | No | — | The cadence step that the person is on |
| `result.data[].step.id` | `integer` | No | — | — |
| `result.data[].step._href` | `string` | No | — | — |
| `result.data[].person` | `object` | No | — | The person that is on the cadence |
| `result.data[].person.id` | `integer` | No | — | — |
| `result.data[].person._href` | `string` | No | — | — |
| `result.data[].user` | `object` | No | — | The user that is acting on the person in the cadence |
| `result.data[].user.id` | `integer` | No | — | — |
| `result.data[].user._href` | `string` | No | — | — |
| `result.data[].latest_action` | `object` | No | — | The most recent action associated with the record |
| `result.data[].latest_action.id` | `integer` | No | — | — |
| `result.data[].counts` | `object` | No | — | — |
| `result.data[].counts.views` | `integer` | No | — | The number of times emails sent from the cadence to the person were opened |
| `result.data[].counts.clicks` | `integer` | No | — | The number of times emails sent from the cadence to the person were clicked |
| `result.data[].counts.replies` | `integer` | No | — | The number of times emails sent from the cadence to the person were replied to |
| `result.data[].counts.calls` | `integer` | No | — | The number of times a call was logged from the cadence to the person |
| `result.data[].counts.sent_emails` | `integer` | No | — | The number of times emails were sent from the cadence to the person |
| `result.data[].counts.bounces` | `integer` | No | — | The number of times emails sent from the cadence to the person bounced |
| `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": "Cadence membership ID"
            },
            "added_at": {
              "type": "string",
              "description": "Datetime of when the person was last added to this cadence",
              "format": "date-time"
            },
            "created_at": {
              "type": "string",
              "description": "Datetime of when the person was first added to this cadence",
              "format": "date-time"
            },
            "updated_at": {
              "type": "string",
              "description": "Datetime of when the record was last updated",
              "format": "date-time"
            },
            "person_deleted": {
              "type": "boolean",
              "description": "Whether the associated person has since been deleted"
            },
            "currently_on_cadence": {
              "type": "boolean",
              "description": "Whether the person is currently on the cadence"
            },
            "current_state": {
              "type": "string",
              "description": "The current state of the person on the cadence. Possible values are: processing: The person is being processed on a cadence. Cadence-related changes cannot be made at this time staged: The person is waiting for the first step in the cadence to occur active: The cadence has begun processing this person and is still in the process, but idle scheduled: The cadence has begun processing this person and is still in the process, with an activity scheduled to occur pending: The person is waiting to be added to the cadence due to throttling limits completed: The cadence has been completed for this person removed: The person was manually or automatically removed from the cadence removed_no_action: The person was removed from the cadence before any action occurred reassigned: The person's cadence execution was transferred to a different user, ending this user's interaction archived: The cadence this person belonged to has been archived and all actions and people were archived with it"
            },
            "cadence": {
              "type": "object",
              "description": "The cadence that the person is on",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "step": {
              "type": "object",
              "description": "The cadence step that the person is on",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "person": {
              "type": "object",
              "description": "The person that is on the cadence",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "user": {
              "type": "object",
              "description": "The user that is acting on the person in the cadence",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "_href": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "latest_action": {
              "type": "object",
              "description": "The most recent action associated with the record",
              "properties": {
                "id": {
                  "type": "integer"
                }
              },
              "additionalProperties": false
            },
            "counts": {
              "type": "object",
              "properties": {
                "views": {
                  "type": "integer",
                  "description": "The number of times emails sent from the cadence to the person were opened"
                },
                "clicks": {
                  "type": "integer",
                  "description": "The number of times emails sent from the cadence to the person were clicked"
                },
                "replies": {
                  "type": "integer",
                  "description": "The number of times emails sent from the cadence to the person were replied to"
                },
                "calls": {
                  "type": "integer",
                  "description": "The number of times a call was logged from the cadence to the person"
                },
                "sent_emails": {
                  "type": "integer",
                  "description": "The number of times emails were sent from the cadence to the person"
                },
                "bounces": {
                  "type": "integer",
                  "description": "The number of times emails sent from the cadence to the person bounced"
                }
              },
              "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.