> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# LeadDocket

> How to set up the LeadDocket connector, plus the actions that are available.

![LeadDocket](https://stackone-logos.com/api/lead-docket/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/leaddocket/changelog.md)

[26 actions](#actions) · 1 auth method

CRM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/leaddocket/guides/connector-profile/api-key.md)
>
> Authenticate using your LeadDocket API key found in Manage > Settings > Account Settings.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/leaddocket/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

26 actions

ActionDescription

List Leads`leaddocket_list_leads`

Retrieve a paginated list of leads filtered by status ID with optional sub-status filtering and sort order

List Leads Updated Since`leaddocket_list_leads_updated_since`

Retrieve all leads updated since a given date, covering both status changes and edit events

Get Lead`leaddocket_get_lead`

Retrieve full details of a single lead by ID including contact info, notes, messages, files, and custom fields

Get Lead Basic`leaddocket_get_lead_basic`

Retrieve basic information for a single lead without notes, messages, and other nested lists

Update Lead`leaddocket_update_lead`

Update properties of an existing lead such as case type, summary, incident date, office, and source

Change Lead Status`leaddocket_change_lead_status`

Change the status of a lead with optional sub-status, severity level, assigned users, and notes

Add Lead Note`leaddocket_add_lead_note`

Add a new note to a specified lead

Create Contact`leaddocket_create_contact`

Create a new contact with name, address, phone, email, and other details

Get Contact`leaddocket_get_contact`

Retrieve a single contact by ID with full details including custom fields and tags

Update Contact`leaddocket_update_contact`

Update an existing contact's name, address, phone, email, and other properties

Search Contacts`leaddocket_search_contacts`

Search for contacts by name, email, or phone number

List Contacts Updated Since`leaddocket_list_contacts_updated_since`

Retrieve all contacts updated since a given date with pagination

Get Opportunity`leaddocket_get_opportunity`

Retrieve full details of an opportunity by ID including contact info, status, and custom fields

List Unprocessed Opportunities`leaddocket_list_opportunities_unprocessed`

Retrieve all opportunities that have not been processed into leads

List Opportunities Created Since`leaddocket_list_opportunities_created_since`

Retrieve all opportunities created since a specific date with pagination

List Opportunities Updated Since`leaddocket_list_opportunities_updated_since`

Retrieve all opportunities updated since a specific date with pagination

List Users`leaddocket_list_users`

Retrieve a list of all LeadDocket users with their roles and permissions

Get User`leaddocket_get_user`

Retrieve a single user by ID with roles and permissions

List Users By Role`leaddocket_list_users_by_role`

Retrieve users assigned to a specific role by role ID

List Statuses`leaddocket_list_statuses`

Retrieve all lead statuses with their sub-statuses and configuration

Get Status`leaddocket_get_status`

Retrieve a single status by ID with its sub-statuses and configuration

List Tasks By Lead`leaddocket_list_tasks_by_lead`

Retrieve all tasks for a specific lead

Get Task`leaddocket_get_task`

Retrieve a single task by ID

Create Task`leaddocket_create_task`

Create a new task on a lead with summary, start date, assigned user, and type

Update Task`leaddocket_update_task`

Update an existing task's summary, start date, assigned user, type, or completion status

Delete Task`leaddocket_delete_task`

Delete a task by ID


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.