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

> List or search the users on your Salesloft team by name, email, group, role or active status. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List or search the users on your Salesloft team by name, email, group, role or active status.

> [!NOTE]
>
> Tool ID: `salesloft_users_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_users_index',
  {
    "ids": [
      123
    ],
    "guid": [
      "example"
    ],
    "group_id": [
      "group_123"
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesloft_users_index --input '{
  "ids": [
    123
  ],
  "guid": [
    "example"
  ],
  "group_id": [
    "group_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,
      "guid": "example",
      "name": "Example"
    }
  ]
}
```

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

## Input reference

Non Admin: Lists only your user, or all on team depending on group visibility policy Team Admin: Lists users associated with your team

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.ids` | `array` | No | — | IDs of users to fetch. If a record can't be found, that record won't be returned and your request will be successful |
| `payload.guid` | `array` | No | — | Filters list to only include guids |
| `payload.group_id` | `array` | No | — | Filters users by group\_id. An additional value of "\_is\_null" can be passed to filter users that are not in a group |
| `payload.role_id` | `array` | No | — | Filters users by role\_id |
| `payload.search` | `string` | No | — | Space-separated list of keywords used to find case-insensitive substring matches against First Name, Last Name, or Email |
| `payload.emails` | `array` | No | — | Array of email addresses to search for exact matches |
| `payload.active` | `boolean` | No | — | Filters users based on active attribute. Defaults to not applied |
| `payload.visible_only` | `boolean` | No | — | Defaults to true. When true, only shows users that are actionable based on the team's privacy settings. When false, shows all users on the team, even if you can't take action on that user. Deactivated users are also included when false. |
| `payload.per_page` | `integer` | No | — | How many users to show per page in the range \[1, 100]. Defaults to 25. Results are only paginated if the page parameter is defined |
| `payload.page` | `integer` | No | — | The current page to fetch users from. Defaults to returning all users |
| `payload.include_paging_counts` | `boolean` | No | — | Whether to include total\_pages and total\_count in the metadata. Defaults to false |
| `payload.has_crm_user` | `boolean` | No | — | Filters users based on if they have a crm user mapped or not. |
| `payload.work_country` | `array` | No | — | Filters users based on assigned work\_country. |
| `payload.seat_package` | `array` | No | — | Filters users based on assigned license. |
| `payload.managed_ar` | `boolean` | No | — | Filters users based on managing the Automation Rules. |
| `payload.manager_user_guid` | `array` | No | — | Filters users based on the manager's user\_guid |
| `payload.permissions` | `array` | No | — | Filters users based on specific permissions. |
| `payload.last_login` | `string` | No | — | Filters users based on last login time |
| `payload.calendar_connection_status` | `boolean` | No | — | Filters users by calendar connection status. When true, returns only users with a connected calendar. When false, returns only users without a connected calendar. |
| `payload.include_calendar_connection_status` | `boolean` | No | — | Whether to include calendar connection status in the response. Defaults to false. When true, adds a calendar\_connection\_status object to each user in the response that includes booleans for whether the user has a calendar connected and whether that calendar connection is valid |
| `payload.sort_by` | `string` | No | — | Key to sort on, must be one of: id, seat\_package, email, name, group, last\_login, role. Defaults to id |
| `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": "Non Admin: Lists only your user, or all on team depending on group visibility policy Team Admin: Lists users associated with your team",
    "properties": {
      "ids": {
        "type": "array",
        "description": "IDs of users to fetch. If a record can't be found, that record won't be returned and your request will be successful",
        "items": {
          "type": "integer"
        }
      },
      "guid": {
        "type": "array",
        "description": "Filters list to only include guids",
        "items": {
          "type": "string"
        }
      },
      "group_id": {
        "type": "array",
        "description": "Filters users by group_id. An additional value of \"_is_null\" can be passed to filter users that are not in a group",
        "items": {
          "type": "string"
        }
      },
      "role_id": {
        "type": "array",
        "description": "Filters users by role_id",
        "items": {
          "type": "string"
        }
      },
      "search": {
        "type": "string",
        "description": "Space-separated list of keywords used to find case-insensitive substring matches against First Name, Last Name, or Email"
      },
      "emails": {
        "type": "array",
        "description": "Array of email addresses to search for exact matches",
        "items": {
          "type": "string"
        }
      },
      "active": {
        "type": "boolean",
        "description": "Filters users based on active attribute. Defaults to not applied"
      },
      "visible_only": {
        "type": "boolean",
        "description": "Defaults to true. When true, only shows users that are actionable based on the team's privacy settings. When false, shows all users on the team, even if you can't take action on that user. Deactivated users are also included when false."
      },
      "per_page": {
        "type": "integer",
        "description": "How many users to show per page in the range [1, 100]. Defaults to 25. Results are only paginated if the page parameter is defined"
      },
      "page": {
        "type": "integer",
        "description": "The current page to fetch users from. Defaults to returning all users"
      },
      "include_paging_counts": {
        "type": "boolean",
        "description": "Whether to include total_pages and total_count in the metadata. Defaults to false"
      },
      "has_crm_user": {
        "type": "boolean",
        "description": "Filters users based on if they have a crm user mapped or not."
      },
      "work_country": {
        "type": "array",
        "description": "Filters users based on assigned work_country.",
        "items": {
          "type": "string"
        }
      },
      "seat_package": {
        "type": "array",
        "description": "Filters users based on assigned license.",
        "items": {
          "type": "string"
        }
      },
      "managed_ar": {
        "type": "boolean",
        "description": "Filters users based on managing the Automation Rules."
      },
      "manager_user_guid": {
        "type": "array",
        "description": "Filters users based on the manager's user_guid",
        "items": {
          "type": "string"
        }
      },
      "permissions": {
        "type": "array",
        "description": "Filters users based on specific permissions.",
        "items": {
          "type": "string"
        }
      },
      "last_login": {
        "type": "string",
        "description": "Filters users based on last login time"
      },
      "calendar_connection_status": {
        "type": "boolean",
        "description": "Filters users by calendar connection status. When true, returns only users with a connected calendar. When false, returns only users without a connected calendar."
      },
      "include_calendar_connection_status": {
        "type": "boolean",
        "description": "Whether to include calendar connection status in the response. Defaults to false. When true, adds a calendar_connection_status object to each user in the response that includes booleans for whether the user has a calendar connected and whether that calendar connection is valid"
      },
      "sort_by": {
        "type": "string",
        "description": "Key to sort on, must be one of: id, seat_package, email, name, group, last_login, role. Defaults to id"
      },
      "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 | — | User ID |
| `result.data[].guid` | `string` | No | — | Globally unique user ID. New endpoints will explicitly accept this over id |
| `result.data[].name` | `string` | No | — | Display name of user |
| `result.data[].email` | `string` | No | — | Email address provided to accounts.salesloft.com |
| `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": "User ID"
            },
            "guid": {
              "type": "string",
              "description": "Globally unique user ID. New endpoints will explicitly accept this over id"
            },
            "name": {
              "type": "string",
              "description": "Display name of user"
            },
            "email": {
              "type": "string",
              "description": "Email address provided to accounts.salesloft.com"
            }
          },
          "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.