### GET /account

Source: https://developers.nutshell.com/reference

Retrieves account information from the Nutshell instance.

```APIDOC
## GET /account

### Description
Retrieves a list of accounts and associated metadata from the Nutshell instance.

### Method
GET

### Endpoint
/account

### Response
#### Success Response (200)
- **meta** (object) - Information about the Nutshell instance making the request
- **accounts** (array) - An array of returned accounts

#### Response Example
{
  "meta": {
    "instanceId": "string",
    "siteId": "string"
  },
  "accounts": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "createdTime": "int64",
      "deletedTime": "int64",
      "emails": [],
      "addresses": [],
      "phones": [],
      "urls": [],
      "avatarUrl": "string",
      "initials": "string",
      "htmlUrl": "string",
      "htmlUrlPath": "string",
      "href": "string",
      "revenue": "object",
      "employeeCount": "integer",
      "creators": [],
      "owners": [],
      "origins": [],
      "contacts": []
    }
  ]
}
```

--------------------------------

### GET /stages

Source: https://developers.nutshell.com/reference/14af5dd687ab31f65e5af1a2b1fa5527

Retrieves a list of all stages defined in the system.

```APIDOC
## GET /stages

### Description
Retrieves a list of all stages available in the pipeline.

### Method
GET

### Endpoint
/stages

### Response
#### Success Response (200)
- **Array of Stage objects** (array) - A list of stage entities.

#### Response Example
[
  {
    "id": "3-contacts",
    "name": "Prospecting",
    "description": "Identify and qualify potential customers",
    "position": 1,
    "numSteps": 3,
    "canAdvanceStage": true,
    "links": [
      {
        "stageset": "1-stagesets"
      }
    ]
  }
]
```

--------------------------------

### Get a Product

Source: https://developers.nutshell.com/reference/e524bd8b37d52ef8fa586cadacfbbe63

Retrieves details for a specific product using its ID.

```APIDOC
## GET /products/{id}

### Description
Retrieves details for a specific product using its ID.

### Method
GET

### Endpoint
app.nutshell.com/rest/products/{id}

#### Path Parameters
- **id** (string) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **products** (array) - A list containing the product details.
  - **id** (string) - The API ID of this entity, formatted {integer}-{entityType}.
  - **name** (any) - The name of the product.
  - **href** (any) - The URL to the product.
  - **description** (any) - A description of the product.
  - **modifiedTime** (integer) - The timestamp when the product was last modified.
  - **deletedTime** (string) - The timestamp when the product was deleted, in date-time format.
  - **sku** (any) - The Stock Keeping Unit for the product.
  - **productType** (any) - The type of the product.
  - **prices** (object) - An object containing pricing information for different markets.
    - **1-markets** (object) - Pricing details for the '1-markets' category.
      - **amount** (number) - The price amount.
      - **currency** (string) - The currency of the price.
      - **formatted** (string) - The formatted price string.
      - **currencySymbol** (string) - The currency symbol.
  - **price** (object) - The default price information for the product.
    - **amount** (number) - The price amount.
    - **currency** (string) - The currency of the price.
    - **formatted** (string) - The formatted price string.
    - **currencySymbol** (string) - The currency symbol.

#### Response Example
```json
{
  "products": [
    {
      "id": "3-contacts",
      "name": "Example Product",
      "href": "https://app.nutshell.com/rest/products/3-contacts",
      "description": "This is an example product.",
      "modifiedTime": 1678886400,
      "deletedTime": null,
      "sku": "EX-PROD-001",
      "productType": "Standard",
      "prices": {
        "1-markets": {
          "amount": 19.99,
          "currency": "USD",
          "formatted": "$19.99",
          "currencySymbol": "$"
        }
      },
      "price": {
        "amount": 19.99,
        "currency": "USD",
        "formatted": "$19.99",
        "currencySymbol": "$"
      }
    }
  ]
}
```
```

--------------------------------

### GET /markets

Source: https://developers.nutshell.com/reference/9768a284fcd11af320b20036afca17d6

Retrieves a list of all available markets.

```APIDOC
## GET /markets

### Description
Get a list of markets.

### Method
GET

### Endpoint
/markets

### Parameters

### Request Body

### Request Example

### Response
#### Success Response (200)
- **id** (string) - The API ID of this entity, formatted {integer}-{entityType}
- **name** (string) - The name of the market
- **currency** (string) - The currency code for the market
- **currencySymbol** (string) - The symbol for the market's currency
- **isDefault** (boolean) - Indicates if this is the default market

#### Response Example
{
  "id": "3-contacts",
  "name": "US Market",
  "currency": "USD",
  "currencySymbol": "$",
  "isDefault": true
}
```

--------------------------------

### GET /productcategories

Source: https://developers.nutshell.com/reference/717f48307abd255776158e66cbbe8656

Retrieves a list of all product categories available in the system.

```APIDOC
## GET /productcategories

### Description
List all product categories available in the Nutshell system.

### Method
GET

### Endpoint
/productcategories

### Response
#### Success Response (200)
- **productCategories** (array) - A list of ProductCategory objects.

#### Response Example
{
  "productCategories": [
    {
      "id": "3-contacts",
      "name": "string",
      "modifiedTime": 123456789,
      "href": "string"
    }
  ]
}
```

--------------------------------

### GET /activitytypes

Source: https://developers.nutshell.com/reference/e09bcf63999a97ba02d8f461039bbba2

Retrieves a list of all activity types configured in the Nutshell instance.

```APIDOC
## GET /activitytypes

### Description
Retrieves a list of all activity types available in the Nutshell instance.

### Method
GET

### Endpoint
/activitytypes

### Response
#### Success Response (200)
- **meta** (object) - Information about the Nutshell instance making the request
- **activityTypes** (array) - A list of activity type objects

#### Response Example
{
  "meta": {
    "instanceId": "12345",
    "siteId": "string"
  },
  "activityTypes": [
    {
      "id": "3-contacts",
      "name": "string",
      "modifiedTime": 123456789,
      "isBenchmarkable": true
    }
  ]
}
```

--------------------------------

### GET /accounts

Source: https://developers.nutshell.com/reference/ee7a9535ab7ae30da91d6d9cebe2ed85

Retrieves a list of all accounts and associated data from the Nutshell instance.

```APIDOC
## GET /accounts

### Description
Get all accounts and associated data in your Nutshell instance. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI.

### Method
GET

### Endpoint
/accounts
```

--------------------------------

### GET /notes

Source: https://developers.nutshell.com/reference/c855c6708aa8bb59e12dd00ac6afbd04

Retrieves a list of notes from the system with optional pagination parameters.

```APIDOC
## GET /notes

### Description
Get a list of notes.

### Method
GET

### Endpoint
/notes

### Parameters
#### Query Parameters
- **page[limit]** (string) - Optional - Limit the number of results returned, for pagination.
- **page[page]** (string) - Optional - Request a specific page of results, for pagination. Used in conjunction with the page[limit] parameter. Indexing is 0-based.

### Response
#### Success Response (200)
- **id** (string) - The API ID of this entity, formatted {integer}-{entityType}
- **createdTime** (string) - Creation timestamp
- **deletedTime** (string) - Deletion timestamp
- **href** (string) - Resource link
- **body** (string) - Note content
- **bodyHtml** (string) - HTML formatted content
- **bodyMarkup** (string) - Markup formatted content
- **isEditable** (boolean) - Whether the note is editable
- **parentType** (string) - The type of the parent entity
- **htmlUrl** (string) - The link to the entity within the app
- **htmlUrlPath** (string) - The path to the entity within the app
```

--------------------------------

### Get a list of editions

Source: https://developers.nutshell.com/reference/4a302c8065d7f9015251d17f23bb237e

Retrieves a list of all available editions from the Nutshell API.

```APIDOC
## GET /editions

### Description
Get a list of editions.

### Method
GET

### Endpoint
/editions

### Parameters

### Request Body

### Request Example

### Response
#### Success Response (200)
- **id** (string) - The API ID of this entity, formatted {integer}-{entityType}
- **name** (string)

#### Response Example
{
  "id": "3-contacts",
  "name": "Contacts Edition"
}
```

--------------------------------

### GET /activities

Source: https://developers.nutshell.com/reference/afbafbf6832a5c50439963afb493230f

Retrieves a list of activities. Supports filtering by various criteria.

```APIDOC
## GET /activities

### Description
Retrieves a list of activities. Supports filtering by various criteria.

### Method
GET

### Endpoint
/activities

### Parameters
#### Query Parameters
- **q** (string) - Optional - String search
- **limit** (integer) - Optional - How many activities to return
- **filter[participant][]** (array of strings) - Optional - Which participant to get activities related to
- **filter[status][]** (array of strings) - Optional - Which activities to get based on status. Allowed values: "scheduled", "logged", "cancelled"
- **filter[leadPriority]** (string) - Optional - Whether to only return activities related to hot leads. Allowed values: "hot"
- **filter[activityType]** (array of integers) - Optional - Which types of activities to get
- **filter[flagged]** (boolean) - Optional - Only return flagged activities
- **filter[isImportant]** (boolean) - Optional - Only return activities marked as important
- **filter[dateMin]** (string) - Optional - The earliest activity to return
- **filter[dateMax]** (string) - Optional - The latest activity to return

### Response
#### Success Response (200)
- **activities** (array) - A list of activities.
- **id** (string) - The API ID of this entity, formatted {integer}-{entityType}
- **agenda** (string) - The list of things to accomplish in the activity
- **createdTime** (integer) - The time the activity was created.
- **endTime** (integer) - The time the activity ended.
- **deletedTime** (integer) - The time the activity was deleted.
- **href** (string) - The URL to fetch this contact.
- **isAllDay** (boolean) - Whether the activity is an all-day event.

#### Response Example
{
  "activities": [
    {
      "id": "123-activities",
      "agenda": "Follow up with client",
      "createdTime": 1678886400,
      "endTime": 1678890000,
      "deletedTime": null,
      "href": "https://app.nutshell.com/rest/activities/123-activities",
      "isAllDay": false
    }
  ],
  "id": "123-activities",
  "agenda": "Follow up with client",
  "createdTime": 1678886400,
  "endTime": 1678890000,
  "deletedTime": null,
  "href": "https://app.nutshell.com/rest/activities/123-activities",
  "isAllDay": false
}
```

--------------------------------

### GET /tasks

Source: https://developers.nutshell.com/reference/2fe0bcdbe5941e2cfdc54a7c09b54200

Retrieve a list of tasks with optional filtering and pagination support.

```APIDOC
## GET /tasks

### Description
Retrieve a list of tasks from the system. Supports filtering by assignee, related entity, and date ranges, as well as pagination.

### Method
GET

### Endpoint
/tasks

### Parameters
#### Query Parameters
- **q** (string) - Optional - Query for tasks that match a specific string
- **filter[assignee]** (array) - Optional - Filter tasks by assignee
- **filter[relatedEntity]** (string) - Optional - Filter tasks by related entity
- **filter[dateMin]** (string) - Optional - Filter tasks created after this date. Date expected in the format YYYY-MM-DD
- **filter[dateMax]** (string) - Optional - Filter tasks created before this date. Date expected in the format YYYY-MM-DD
- **page[limit]** (string) - Optional - Limit the number of results returned, for pagination.
- **page[page]** (string) - Optional - Request a specific page of results, for pagination. Used in conjunction with the page[limit] parameter. Indexing is 0-based.

### Response
#### Success Response (200)
- **description** (string) - A list of tasks
```

--------------------------------

### GET /users

Source: https://developers.nutshell.com/reference/d3997a48c80629bf9a63637c4fde9aab

Retrieves a paginated list of users from the system. This endpoint requires basic authentication.

```APIDOC
## GET /users

### Description
Retrieves a list of users. This endpoint returns a paginated response containing user details and metadata.

### Method
GET

### Endpoint
app.nutshell.com/rest/users

### Response
#### Success Response (200)
- **meta** (object) - Metadata including pagination links and total count.
- **users** (array) - A list of user objects.

#### Response Example
{
  "meta": {
    "next": "string",
    "previous": "string",
    "total": 0
  },
  "users": [
    {
      "id": "3-contacts",
      "name": "string",
      "firstName": "string",
      "modifiedTime": 0,
      "isEnabled": true,
      "hasSetPassword": true,
      "isAdministrator": true,
      "isViewingRestricted": true,
      "isHiddenFromFilters": true,
      "canAccessEmailMarketing": true,
      "permissions": {},
      "emails": ["string"],
      "phonecallerType": "string",
      "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
      "initials": "string"
    }
  ]
}
```

--------------------------------

### POST /sources

Source: https://developers.nutshell.com/reference/cd431c40f2b57127c71b15044d270a13

Create a new source for leads in your Nutshell instance. Sources are used to track how leads arrive at your website and learn about your business.

```APIDOC
## POST /sources

### Description
Create a new source for leads in your Nutshell instance. Sources are used to track how leads arrive at your website and learn about your business.

### Method
POST

### Endpoint
/sources

### Parameters
#### Request Body
- **sources** (array) - Required - An array of source objects to create.
  - **name** (string) - Required - The name of the source.
  - **channel** (integer) - Optional - The channel of the source. 0 = no channel, 1 = organic search, 2 = paid search, 3 = organic social, 4 = paid social, 5 = email, 6 = referrer, 7 = traditional, 8 = direct to website

### Request Example
```json
{
  "sources": [
    {
      "name": "Website Visit",
      "channel": 1
    }
  ]
}
```

### Response
#### Success Response (201)
- **sources** (array) - An array of created source objects.
  - **id** (string) - The API ID of this entity, formatted {integer}-{entityType}.
  - **name** (string) - The name of the source.
  - **href** (string) - The URL to access the source.
  - **modifiedTime** (integer) - Unix Timestamp of the last modification.
  - **channel** (object) - Channels group sources into broader groups.
    - **value** (integer) - The channel's numerical value.
    - **display** (string) - The channel's display name.
  - **deletedTime** (integer) - Unix Timestamp if the source is deleted.

#### Response Example
```json
{
  "sources": [
    {
      "id": "123-sources",
      "name": "Website Visit",
      "href": "https://app.nutshell.com/rest/sources/123",
      "modifiedTime": 1704774720,
      "channel": {
        "value": 1,
        "display": "Organic search"
      },
      "deletedTime": null
    }
  ]
}
```
```

--------------------------------

### Get a form OpenAPI definition

Source: https://developers.nutshell.com/reference/c150c11fa75e601f12a5d0c3291b7e9c

Defines the GET /forms/{id} endpoint and the associated data models for forms and fields.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Nutshell API",
    "description": "The most powerful API in the world",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "app.nutshell.com/rest"
    }
  ],
  "paths": {
    "/forms/{id}": {
      "get": {
        "tags": [
          "Forms"
        ],
        "summary": "Get a form",
        "description": "Get a single form by the ID provided. The fields used in the form are also returned in the response.",
        "operationId": "c150c11fa75e601f12a5d0c3291b7e9c",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Form ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Form",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/FormResponse"
                    },
                    {
                      "properties": {
                        "wfFields": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Field"
                          }
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Field": {
        "properties": {
          "id": {
            "description": "The API ID of this entity, formatted {integer}-{entityType}",
            "type": "string",
            "example": "3-contacts"
          },
          "label": {
            "type": "string",
            "example": "Full Name"
          },
          "fieldName": {
            "type": "string",
            "example": "name"
          },
          "fieldType": {
            "type": "string",
            "example": "textfield"
          },
          "entityName": {
            "type": "string",
            "example": "Contacts"
          }
        },
        "type": "object"
      },
      "FormResponse": {
        "description": "A full response object for a form-related endpoint.",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/meta"
          },
          "links": {
            "type": "object"
          },
          "wfForms": {
            "type": "array",
            "items": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Form"
                },
                {
                  "$ref": "#/components/schemas/FormLinks"
                }
              ]
            }
          }
        },
        "type": "object"
      },
      "FormLinks": {
        "properties": {
          "links": {
            "description": "The IDs of the fields in the form",
            "properties": {
              "fields": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "1-wfFields"
                }
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "Form": {
        "properties": {
          "id": {
            "description": "The API ID of this entity, formatted {integer}-{entityType}",
            "type": "string",
            "example": "3-contacts"
          },
          "name": {
            "description": "The name of the form",
            "type": "string",
            "example": "Client Questionnaire"
          },
          "href": {
            "type": "string"
          },
          "createdTime": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "meta": {
        "description": "Information about the Nutshell instance making the request",
        "properties": {
          "instanceId": {
            "description": "The Nutshell instance ID",
            "type": "string",
            "example": "12345"
          },
          "siteId": {
            "description": "Site ID for WebFX customers",
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "tags": [
    {
      "name": "Forms",
      "description": "Forms"
    }
  ]
}
```

--------------------------------

### POST /activities

Source: https://developers.nutshell.com/reference/245ac4db7d1ce9919113871e1fd9d14c

Creates a new activity in Nutshell. This endpoint allows for the creation of a single or multiple activities with detailed information.

```APIDOC
## POST /activities

### Description
Creates a new activity in Nutshell. This endpoint allows for the creation of a single or multiple activities with detailed information.

### Method
POST

### Endpoint
app.nutshell.com/rest/activities

### Request Body
- **activities** (array) - Required - An array of activity objects to be created.
  - **name** (string) - Optional - The name of the activity.
  - **description** (string) - Optional - The agenda for the activity.
  - **note** (string) - Optional - An internal note about the activity.
  - **location** (string) - Optional - Where the activity will take place.
  - **activityType** (string) - Optional - The type of activity. See GET /activitytypes.
  - **startTime** (integer) - Optional - Unix timestamp for the start time.
  - **endTime** (integer) - Optional - Unix timestamp for the end time.
  - **transcription** (string) - Optional - The transcription of the activity.
  - **isFlagged** (boolean) - Optional - Whether the activity is marked as important.
  - **isLogged** (boolean) - Optional - Whether the activity has occurred.
  - **isAllDay** (boolean) - Optional - Whether the activity is an all-day event.
  - **links** (object) - Optional - Contains entity IDs of activity participants.
    - **participants** (array) - Optional - An array of participant IDs.

### Request Example
```json
{
  "activities": [
    {
      "name": "Call with Andy Fowler",
      "description": "Discuss the new feature set",
      "note": "Andy was very excited about the new feature set",
      "location": "Andy's office",
      "activityType": "1-activityTypes",
      "startTime": 1678886400,
      "endTime": 1678890000,
      "transcription": "Speaker 1: Hello.\n Speaker 2: Good morning!",
      "isFlagged": false,
      "isLogged": true,
      "isAllDay": false,
      "links": {
        "participants": ["123-contacts", "456-contacts"]
      }
    }
  ]
}
```

### Response
#### Success Response (201)
- **activities** (array) - A list of created activity objects.
  - **id** (string) - The API ID of the activity.
  - **agenda** (string) - The list of things to accomplish in the activity.
  - **createdTime** (integer) - Unix timestamp of when the activity was created.
  - **endTime** (integer) - Unix timestamp of when the activity ends.

#### Response Example
```json
{
  "activities": [
    {
      "id": "1-activities",
      "agenda": "Discuss the new feature set",
      "createdTime": 1678886400,
      "endTime": 1678890000
    }
  ]
}
```
```

--------------------------------

### OpenAPI Definition for Get Lead Custom Fields

Source: https://developers.nutshell.com/reference/83433994d9721607dea58b99daf963ee

This OpenAPI definition describes the GET endpoint for retrieving custom fields of a lead. It specifies the request parameters, response structure, and authentication methods.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Nutshell API",
    "description": "The most powerful API in the world",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "app.nutshell.com/rest"
    }
  ],
  "paths": {
    "/leads/{id}/customfields": {
      "get": {
        "tags": [
          "Leads"
        ],
        "summary": "Get a lead's custom fields",
        "description": "Get a list of custom fields that are applied to a lead.",
        "operationId": "83433994d9721607dea58b99daf963ee",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Lead ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Custom Fields",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/FullCustomField"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "FullCustomField": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/CustomField"
          },
          {
            "properties": {
              "value": {
                "description": "Custom fields can be many different types, see the guide on Custom Fields for more info.",
                "type": "string"
              },
              "id": {
                "description": "The API ID of this entity, formatted {integer}-{entityType}",
                "type": "string",
                "example": "3-contacts"
              }
            },
            "type": "object"
          }
        ]
      },
      "CustomField": {
        "properties": {
          "id": {
            "description": "The API ID of this entity, formatted {integer}-{entityType}",
            "type": "string",
            "example": "3-contacts"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "tags": [
    {
      "name": "Leads",
      "description": "Leads"
    }
  ]
}
```

--------------------------------

### OpenAPI definition for Get a product

Source: https://developers.nutshell.com/reference/e524bd8b37d52ef8fa586cadacfbbe63

Defines the /products/{id} endpoint and the associated Product and productPrice schemas.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Nutshell API",
    "description": "The most powerful API in the world",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "app.nutshell.com/rest"
    }
  ],
  "paths": {
    "/products/{id}": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Get a product",
        "operationId": "e524bd8b37d52ef8fa586cadacfbbe63",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Product",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ProductResponse": {
        "description": "A full response object for a product-related endpoint.",
        "properties": {
          "products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Product"
            }
          }
        },
        "type": "object"
      },
      "Product": {
        "properties": {
          "id": {
            "description": "The API ID of this entity, formatted {integer}-{entityType}",
            "type": "string",
            "example": "3-contacts"
          },
          "name": {},
          "href": {},
          "description": {},
          "modifiedTime": {
            "type": "integer"
          },
          "deletedTime": {
            "type": "string",
            "format": "date-time"
          },
          "sku": {},
          "productType": {},
          "prices": {
            "properties": {
              "1-markets": {
                "$ref": "#/components/schemas/productPrice"
              }
            },
            "type": "object"
          },
          "price": {
            "$ref": "#/components/schemas/productPrice"
          }
        },
        "type": "object"
      },
      "productPrice": {
        "properties": {
          "amount": {
            "type": "number"
          },
          "currency": {
            "type": "string"
          },
          "formatted": {
            "type": "string"
          },
          "currencySymbol": {
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "tags": [
    {
      "name": "Products",
      "description": "Products"
    }
  ]
}
```

--------------------------------

### GET /leads

Source: https://developers.nutshell.com/reference/132e65861bebcb3781c3d37e66aff309

Retrieves a list of leads from the Nutshell instance. Supports filtering, sorting, and pagination.

```APIDOC
## GET /leads

### Description
Get a list of all leads and associated data in your Nutshell Instance.

### Method
GET

### Endpoint
/leads

### Parameters
#### Query Parameters
- **q** (string) - Optional - Used to search all related info on an entity. Returns all entities that are similar to the query term.
- **sort** (string) - Optional - Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order. Allowed values: -age, -value, -milestone, -confidence, -name, -closedTime, -owner, -sources, age, value, milestone, confidence, name, closedTime, owner, sources.
- **filter** (object) - Optional - Filter the returned leads based on various criteria. Use /rest/leads/list/fields to get a full list of valid filter keys. The schema for filter values is defined by FilterInput.
- **page[page]** (integer) - Optional - The page of results to return. Indexing is 0-based.
- **page[limit]** (integer) - Optional - How many results to return per page

### Response
#### Success Response (200)
- **meta** (object) - Metadata about the response.
- **links** (object) - Links related to the response.
- **leads** (array) - An array of lead objects.
  - **items** (object) - Represents a single lead.
    - **id** (string) - The API ID of this entity, formatted {integer}-{entityType}.
    - **deletedTime** (string) - The time the lead was deleted.
    - **name** (string) - The full name of the lead.
    - **value** (object) - The value of the lead.
    - **number** (integer) - The lead number.

#### Response Example
{
  "meta": {},
  "links": {},
  "leads": [
    {
      "id": "3-contacts",
      "deletedTime": null,
      "name": "John Doe",
      "value": {},
      "number": 123
    }
  ]
}

```

--------------------------------

### GET /territories

Source: https://developers.nutshell.com/reference/cf95ba52f86fef3511b456449ca9f9a9

Retrieves a list of all territories available in the system.

```APIDOC
## GET /territories

### Description
Retrieves a list of territories.

### Method
GET

### Endpoint
/territories

### Response
#### Success Response (200)
- **Array** (Territory) - A list of territory objects.

#### Response Example
[
  {
    "id": "3-contacts",
    "name": "Example Territory",
    "href": "/territories/3-contacts",
    "modifiedTime": 1625097600
  }
]
```

--------------------------------

### Get a list of sources

Source: https://developers.nutshell.com/reference/2d07cb07b45de2ae13701b873b26cf9e

Retrieves a list of all possible sources for leads within your Nutshell instance. Supports filtering by a query string.

```APIDOC
## GET /sources

### Description
Returns a list of all possible sources for leads in your Nutshell instance.

### Method
GET

### Endpoint
/sources

### Parameters
#### Query Parameters
- **q** (string) - Optional - Query for sources that match a specific string

### Response
#### Success Response (200)
- **sources** (array) - An array of source objects.
  - **id** (string) - The API ID of this entity, formatted {integer}-{entityType}
  - **name** (string) - The name of the source.
  - **href** (string) - The URL for the source.
  - **modifiedTime** (integer) - Unix Timestamp of the last modification.
  - **channel** (object) - Channels group sources into broader groups.
    - **value** (integer) - The channel's numerical value.
    - **display** (string) - The display name of the channel.
  - **deletedTime** (integer) - Unix Timestamp of when the source was deleted.

#### Response Example
```json
{
  "sources": [
    {
      "id": "3-contacts",
      "name": "Google",
      "href": "https://app.nutshell.com/api/v1/source/3-contacts",
      "modifiedTime": 1704774720,
      "channel": {
        "value": 1,
        "display": "Organic search"
      },
      "deletedTime": null
    }
  ]
}
```
```

--------------------------------

### Get a Task

Source: https://developers.nutshell.com/reference/04c249286f1032bdf6d8178e0e9f384c

Retrieves a single task by its unique identifier.

```APIDOC
## GET /tasks/{id}

### Description
Get a single task by the ID provided.

### Method
GET

### Endpoint
/tasks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Task ID

### Response
#### Success Response (200)
- **id** (string) - The API ID of this entity, formatted {integer}-{entityType}
- **htmlUrl** (string) - The link to the entity within the app.
- **htmlUrlPath** (string) - The path to the entity within the app.

#### Response Example
{
  "id": "3-contacts",
  "htmlUrl": "https://app.nutshell.com/lead/1006",
  "htmlUrlPath": "/lead/1006"
}
```

--------------------------------

### POST /leads - Create a Lead

Source: https://developers.nutshell.com/reference/7d9961f8fbd457ba5670721926517135

Allows for the creation of a new lead in the Nutshell system. Only one lead can be created per request.

```APIDOC
## POST /leads

### Description
Create a new lead. Only one lead can be created at a time.

### Method
POST

### Endpoint
/leads

### Parameters
#### Request Body
- **leads** (array) - Required - An array containing lead objects to be created.
  - **description** (string) - Optional - Description of the lead, which is also set as the name of the lead. Example: "Car Wash Inc."
  - **manualValue** (string) - Optional - Value of the lead, will override the value calculated from the products. Example: "999.99"
  - **dueTime** (object) - Optional - Due time for the lead.
  - **customFields** (object) - Optional - Custom fields to add to the Lead. Example: {"Favorite Number": "12"}
  - **links** (object) - Optional - Links to associate with the lead.
    - **accounts** (array of strings) - Optional - IDs of the accounts the lead should be associated with. Example: ["1-accounts"]
    - **contacts** (array of strings) - Optional - IDs of the contacts the lead should be associated with. Example: ["1-contacts"]
    - **owner** (string) - Optional - The ID of the user the lead is assigned to. Example: "1-users"
    - **sources** (array of strings) - Optional - IDs of the sources the lead should be associated with. Example: ["1-sources"]
    - **tags** (array of strings) - Optional - Tags to attach to the lead. Example: ["1-tags"]
    - **productMaps** (array of objects) - Optional - Products to attach to the lead. Requires specifying product ID and mapping details. Example: [ { "productId": "1-products", "price": "100.00" } ]
    - **competitorMaps** (array of strings) - Optional - IDs of competitors to associate with the lead.

### Request Example
```json
{
  "leads": [
    {
      "description": "Car Wash Inc.",
      "manualValue": "999.99",
      "links": {
        "accounts": ["1-accounts"],
        "contacts": ["1-contacts"],
        "owner": "1-users",
        "sources": ["1-sources"],
        "tags": ["1-tags"],
        "productMaps": [
          {
            "productId": "1-products",
            "price": "100.00"
          }
        ],
        "competitorMaps": ["1-competitors"]
      }
    }
  ]
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /rest/accounts/{id}

Source: https://developers.nutshell.com/reference

Retrieves the details of a specific account by its ID.

```APIDOC
## GET /rest/accounts/{id}

### Description
Retrieves the details of a specific account, including associated emails, addresses, and phone numbers.

### Method
GET

### Endpoint
https://app.nutshell.com/rest/accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The API ID of the account.

### Request Example
curl --request GET \
     --url https://app.nutshell.com/rest/accounts/id \
     --header 'accept: application/json'

### Response
#### Success Response (200)
- **meta** (object) - Metadata about the request.
- **accounts** (array) - List of account objects.

#### Response Example
{
  "meta": {
    "instanceId": "12345",
    "siteId": "string"
  },
  "accounts": [
    {
      "id": "3-contacts",
      "name": "Andy Nutshell",
      "addresses": [
        {
          "address_1": "206 E Huron St",
          "city": "Ann Arbor",
          "state": "MI",
          "postalCode": "48103",
          "country": "US"
        }
      ]
    }
  ]
}
```

--------------------------------

### POST /accounts

Source: https://developers.nutshell.com/reference/0e0199fef8e93c05437d3a33104886d1

Endpoint to create a new company account in the Nutshell system.

```APIDOC
## POST /accounts

### Description
Create a new account. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI.

### Method
POST

### Endpoint
/accounts

### Request Body
- **accounts** (array) - Required - List of account objects to create.

### Request Example
{
  "accounts": [
    {
      "name": "Example Corp",
      "phones": [{"isPrimary": true, "name": "Work", "value": "123-456-7890"}],
      "emails": [{"value": "support@nutshell.com"}],
      "urls": [{"value": "http://www.nutshell.com"}],
      "addresses": [{"name": "HQ", "isPrimary": true, "value": {"address_1": "123 Main St", "city": "Ann Arbor", "state": "MI"}}],
      "customFields": {"Favorite Number": "12"}
    }
  ]
}
```

--------------------------------

### GET /accounts

Source: https://developers.nutshell.com/reference/ee7a9535ab7ae30da91d6d9cebe2ed85

Retrieves a list of accounts with their associated details and metadata.

```APIDOC
## GET /accounts

### Description
Retrieves an array of account entities. Each account includes details such as revenue, employee count, and contact information.

### Method
GET

### Endpoint
/accounts

### Response
#### Success Response (200)
- **accounts** (array) - An array of returned accounts.

#### Response Example
{
  "accounts": [
    {
      "id": "3-contacts",
      "name": "Andy Nutshell",
      "revenue": {
        "amount": "8675309.00",
        "formatted": "$8,675,309.00"
      },
      "employeeCount": 50
    }
  ]
}
```

--------------------------------

### GET /deletion-events

Source: https://developers.nutshell.com/reference/eade9331abb11f33feaeb9e9d8ae89a7

Retrieves a feed of every time an entity was deleted.

```APIDOC
## GET /deletion-events

### Description
Retrieve a feed of every time an entity was deleted.

### Method
GET

### Endpoint
/deletion-events
```

--------------------------------

### POST /accounts

Source: https://developers.nutshell.com/reference/0e0199fef8e93c05437d3a33104886d1

Creates a new account with the provided details. Requires authentication.

```APIDOC
## POST /accounts

### Description
Creates a new account.

### Method
POST

### Endpoint
/accounts

### Request Body
- **name** (string) - Required - The name of the account.
- **customFields** (array) - Optional - An array of custom field objects.
  - **id** (string) - Required - The API ID of the custom field (e.g., "3-contacts").

### Request Example
```json
{
  "name": "New Company",
  "customFields": [
    {
      "id": "1-leadsource"
    }
  ]
}
```

### Response
#### Success Response (201)
- **id** (string) - The API ID of the newly created account.
- **name** (string) - The name of the account.
- **revenue** (object) - Revenue details for the account.
  - **amount** (string) - The revenue amount.
  - **formatted** (string) - The formatted revenue amount.
- **employeeCount** (integer) - The number of employees.

#### Response Example
```json
{
  "id": "123-accounts",
  "name": "New Company",
  "revenue": {
    "amount": "10000.00",
    "formatted": "$10,000.00"
  },
  "employeeCount": 50
}
```
```

--------------------------------

### GET /contacts

Source: https://developers.nutshell.com/reference/cde301caba6b033521a71e6bed772a58

Retrieves a list of contacts with optional filtering capabilities.

```APIDOC
## GET /contacts

### Description
Returns a number of contacts which is filterable based on their basic information.

### Method
GET

### Endpoint
/contacts
```