API Endpoints — subpackage_leads

naftiko: 1.0.0-alpha2
info:
  label: API Endpoints — subpackage_leads
  description: 'API Endpoints — subpackage_leads. 6 operations. Lead operation: List Leads. Self-contained Naftiko capability
    covering one Close business surface.'
  tags:
  - Close
  - subpackage_leads
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CLOSE_API_KEY: CLOSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: close-subpackage-leads
    baseUri: https://api.close.com/api/v1
    description: API Endpoints — subpackage_leads business capability. Self-contained, no shared references.
    resources:
    - name: lead
      path: /lead/
      operations:
      - name: list
        method: GET
        description: List Leads
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _limit
          in: query
          type: integer
          description: Number of results to return.
        - name: _skip
          in: query
          type: integer
          description: Number of results to skip before returning, for pagination.
        - name: _fields
          in: query
          type: string
          description: Comma-separated list of fields to include in the response.
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
      - name: create
        method: POST
        description: Create a new lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: lead-merge
      path: /lead/merge/
      operations:
      - name: merge
        method: POST
        description: Merge two leads
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: lead-id
      path: /lead/{id}/
      operations:
      - name: get
        method: GET
        description: Get a single Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: _fields
          in: query
          type: string
          description: Comma-separated list of fields to include in the response.
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
      - name: update
        method: PUT
        description: Update an existing lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
    authentication:
      type: bearer
      token: '{{env.CLOSE_API_KEY}}'
  exposes:
  - type: rest
    namespace: close-subpackage-leads-rest
    port: 8080
    description: REST adapter for API Endpoints — subpackage_leads. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/lead
      name: lead
      description: REST surface for lead.
      operations:
      - method: GET
        name: list
        description: List Leads
        call: close-subpackage-leads.list
        with:
          _limit: rest._limit
          _skip: rest._skip
          _fields: rest._fields
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create a new lead
        call: close-subpackage-leads.create
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lead/merge
      name: lead-merge
      description: REST surface for lead-merge.
      operations:
      - method: POST
        name: merge
        description: Merge two leads
        call: close-subpackage-leads.merge
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lead/{id}
      name: lead-id
      description: REST surface for lead-id.
      operations:
      - method: GET
        name: get
        description: Get a single Lead
        call: close-subpackage-leads.get
        with:
          id: rest.id
          _fields: rest._fields
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update
        description: Update an existing lead
        call: close-subpackage-leads.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete a lead
        call: close-subpackage-leads.delete
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: close-subpackage-leads-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Endpoints — subpackage_leads. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-leads
      description: List Leads
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: close-subpackage-leads.list
      with:
        _limit: tools._limit
        _skip: tools._skip
        _fields: tools._fields
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-lead
      description: Create a new lead
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: close-subpackage-leads.create
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: merge-two-leads
      description: Merge two leads
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: close-subpackage-leads.merge
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-lead
      description: Get a single Lead
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: close-subpackage-leads.get
      with:
        id: tools.id
        _fields: tools._fields
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-existing-lead
      description: Update an existing lead
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: close-subpackage-leads.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-lead
      description: Delete a lead
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: close-subpackage-leads.delete
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.