openapi: 3.1.0
info:
  title: Nutshell REST API
  description: |
    Resource-based REST API for managing CRM data in Nutshell, including
    contacts, leads, accounts, activities, pipelines, and tasks. Nutshell
    also publishes a legacy JSON-RPC API and webhooks. Endpoint scaffold
    below is derived from the public developer overview at
    https://developers.nutshell.com/docs; consult the live reference and
    OpenAPI feed at https://developers.nutshell.com/llms.txt for the
    authoritative resource list.
  version: "1.0"
  contact:
    name: Nutshell Developers
    url: https://developers.nutshell.com
servers:
  - url: https://app.nutshell.com/api/v1
    description: Nutshell REST API base
security:
  - ApiKeyAuth: []
tags:
  - name: Contacts
  - name: Leads
  - name: Accounts
  - name: Activities
  - name: Pipelines
paths:
  /contacts:
    get:
      tags: [Contacts]
      summary: List contacts
      responses:
        '200':
          description: A list of contact records.
  /leads:
    get:
      tags: [Leads]
      summary: List leads
      responses:
        '200':
          description: A list of lead records.
  /accounts:
    get:
      tags: [Accounts]
      summary: List accounts
      responses:
        '200':
          description: A list of account records.
  /activities:
    get:
      tags: [Activities]
      summary: List activities
      responses:
        '200':
          description: A list of activity records.
  /pipelines:
    get:
      tags: [Pipelines]
      summary: List pipelines
      responses:
        '200':
          description: A list of sales pipelines.
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: basic
      description: |
        Authenticate with an API key generated from Nutshell account
        settings. See https://support.nutshell.com/en/articles/8429060
        for guidance on issuing API keys.