openapi: 3.1.0
info:
  title: Streak REST Boxes API
  description: 'RESTful API for the Streak CRM (a Gmail-based pipeline management tool) exposing

    CRUD access to pipelines, boxes (records), stages, custom fields, threads, tasks,

    files, comments, users, and teams.


    Authentication uses HTTP Basic Auth with the API key supplied as the username and

    an empty password. All requests must use HTTPS.

    '
  version: 1.0.0
  contact:
    name: Streak Support
    url: https://streak.readme.io/docs
  license:
    name: Proprietary
servers:
- url: https://api.streak.com/api/v1
  description: Streak API v1
- url: https://api.streak.com/api
  description: Streak API (root, used by some v2 endpoints)
security:
- basicAuth: []
tags:
- name: Boxes
paths:
  /pipelines/{pipelineKey}/boxes:
    parameters:
    - in: path
      name: pipelineKey
      required: true
      schema:
        type: string
    get:
      tags:
      - Boxes
      summary: List all boxes in a pipeline
      operationId: listBoxesInPipeline
      responses:
        '200':
          description: An array of boxes
    put:
      tags:
      - Boxes
      summary: Create a new box in a pipeline
      operationId: createBoxInPipeline
      responses:
        '200':
          description: The created box
  /boxes/{boxKey}:
    parameters:
    - in: path
      name: boxKey
      required: true
      schema:
        type: string
    get:
      tags:
      - Boxes
      summary: Get a single box
      operationId: getBox
      responses:
        '200':
          description: A box object
    post:
      tags:
      - Boxes
      summary: Edit a box (update properties of a box)
      operationId: updateBox
      responses:
        '200':
          description: The updated box
    delete:
      tags:
      - Boxes
      summary: Delete a box
      operationId: deleteBox
      responses:
        '200':
          description: Deletion result
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic Authentication. Set the username to your Streak API key and leave

        the password empty. Obtain an API key from

        https://support.streak.com/en/articles/2612883-get-your-streak-api-key.

        '