Streak API

https://streak.readme.io/
Admin
The Streak API provides comprehensive tools and documentation for developers to programmatically...
Tokens:119,315
Snippets:318
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Create Contact Request Example

Source: https://streak.readme.io/reference/create-a-contact

This example demonstrates how to make a POST request to create a new contact in Streak. It requires a 'teamKey' and at least one of 'name' or 'emailaddresses'. Ensure you include the 'Content-Type' header and authorization.

```bash
curl -X POST \
  https://api.streak.com/v2/contacts \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "teamKey": "YOUR_TEAM_KEY",
  "name": "Sally Ride",
  "emailAddresses": [
    "sally.ride@ladynerds.com"
  ],
  "givenName": "Sally",
  "familyName": "Ride"
}'
```

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

### Get All Projects

Source: https://streak.readme.io/reference/get-team

Retrieves a list of all projects associated with your Streak account. This endpoint is useful for getting an overview of your project landscape.

```APIDOC
## GET /websites/streak_readme_io

### Description
Retrieves a list of all projects associated with your Streak account.

### Method
GET

### Endpoint
/websites/streak_readme_io

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of projects to return.
- **offset** (integer) - Optional - The number of projects to skip before starting to collect the result set.

### Request Example
```
GET /websites/streak_readme_io?limit=10&offset=0
```

### Response
#### Success Response (200)
- **projects** (array) - A list of project objects.
  - **id** (string) - The unique identifier for the project.
  - **name** (string) - The name of the project.
  - **createdAt** (string) - The timestamp when the project was created.

#### Response Example
```json
{
  "projects": [
    {
      "id": "proj_123",
      "name": "Project Alpha",
      "createdAt": "2023-10-27T10:00:00Z"
    },
    {
      "id": "proj_456",
      "name": "Project Beta",
      "createdAt": "2023-10-26T15:30:00Z"
    }
  ]
}
```
```

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

### Get Box Timeline - OpenAPI Definition

Source: https://streak.readme.io/reference/get-timeline-for-a-box

This OpenAPI definition describes the GET endpoint for retrieving the timeline of a specific box. It details parameters such as boxKey, filters, direction, startTimestamp, limit, and nextPageToken, along with example responses for success and error cases.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "DIRECTORY FIELDS",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.streak.com/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/boxes/{boxKey}/timeline": {
      "get": {
        "summary": "Get timeline for a box",
        "description": "",
        "operationId": "get-timeline-for-a-box",
        "parameters": [
          {
            "name": "boxKey",
            "in": "path",
            "description": "The key of the box to get the timeline for",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filters",
            "in": "query",
            "description": "An array of entity types to return, possible values: CALL_LOGS, COMMENTS, FILES, EMAILS, HANGOUTS_CHAT, MEETING_NOTES, NEWSFEED_BOX_CREATION_MOVE, NEWSFEED_BOX_EDIT. You can specify any number of these types and only matching entities will be returned. Not supplying this parameter or supplying an empty array will result in all entity types being included in the response.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "default": [
                "[]"
              ]
            }
          },
          {
            "name": "direction",
            "in": "query",
            "description": "Whether to return results in ascending timestamp or descending timestamp order",
            "schema": {
              "type": "string",
              "enum": [
                "Ascending",
                "Descending"
              ],
              "default": "Descending"
            }
          },
          {
            "name": "startTimestamp",
            "in": "query",
            "description": "The timestamp to start returning results from. If the direction is ascending, then all entities returned will have a larger timestamp than the one provided. The opposite for descending.",
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": null
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of items to return per page",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "nextPageToken",
            "in": "query",
            "description": "A token returned from a previous request to provide the next page of results. If this parameter is provided, NO other parameters can be specified.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"entries\": [\n    {\n      \"key\": {entityKey},\n      \"type\": \"THREAD\",\n      \"timelineDate\": 1663950282000,\n      \"obj\": {\n        // ... some entity object here\n      },\n      \"children\": []\n    },\n    {\n      \"key\": {entityKey},\n      \"type\": \"NEWSFEED_ENTRY\",\n      \"timelineDate\": 1657739432782,\n      \"obj\": {\n        // ... some other entity object here\n      }\n      \"children\": []\n    },\n  ],
  \"nextPage\": {nextPageToken}
}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

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

### Example JSON Payload for Batch Move Boxes

Source: https://streak.readme.io/reference/batch-move-boxes-to-a-different-pipeline

An example of the JSON payload required for the batch move boxes API request. This payload is an array of objects, where each object specifies the key of the box and the new pipeline key it should be moved to. Note that the JSON array must start immediately, without a wrapping key.

```json
[{"key":"boxKey1","boxKey":"boxKey1","pipelineKey":"newPipelineKey"},{"key":"boxKey2","boxKey":"boxKey2","pipelineKey":"newPipelineKey"}]
```

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

### Create New Project

Source: https://streak.readme.io/reference/update-a-meeting

Creates a new project within the system.

```APIDOC
## POST /api/projects

### Description
Creates a new project with the provided details.

### Method
POST

### Endpoint
/api/projects

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new project.
- **description** (string) - Optional - A brief description of the project.

### Request Example
```json
{
  "name": "New Marketing Campaign",
  "description": "Campaign details for Q3"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the newly created project.
- **name** (string) - The name of the project.
- **createdAt** (string) - The timestamp when the project was created.

#### Response Example
```json
{
  "id": "proj789",
  "name": "New Marketing Campaign",
  "createdAt": "2023-10-27T10:00:00Z"
}
```
```

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

### Get all comments in a box (OpenAPI)

Source: https://streak.readme.io/reference/get-all-comments

This OpenAPI definition outlines the 'get-all-comments' endpoint for the Streak API. It specifies the request parameters, including the box key, and details the structure of successful (200) and error (400) responses, including example JSON payloads.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "DIRECTORY FIELDS",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.streak.com/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/boxes/{boxKey}/comments": {
      "get": {
        "summary": "Get all comments in a box",
        "description": "This call lets you get all comments in a specific [box](reference#box).",
        "operationId": "get-all-comments",
        "parameters": [
          {
            "name": "boxKey",
            "in": "path",
            "description": "The box key for the comments you'd like to retrieve",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"hasNextPage\": false,\n  \"results\": [\n    {\n      \"boxKey\": \"yNAsSDE9yZ2FuaXphdGlvb\",\n      \"pipelineKey\": \"agxzfm1haW\",\n      \"creatorKey\": \"agxzfm1haW\",\n      \"newsfeedEntryKey\": \"ffSDU5ld3NmZWVkRW50\",\n      \"timestamp\": 1557856962657,\n      \"message\": \"Yeah, yeah, indubitably, yeah.\",\n      \"commentKey\": \"agxzfm1haW\",\n      \"key\": \"agxzfm1haW\",\n      \"lastSavedTimestamp\": 1557856962736\n    }\n]"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

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

### POST /websites/streak_readme_io/boxes

Source: https://streak.readme.io/reference/create-a-box

Creates a new box based on the provided pipelineKey. Ensure requests are JSON and include authorization.

```APIDOC
## POST /websites/streak_readme_io/boxes

### Description
This call creates a box based on the pipelineKey you provide.

### Method
POST

### Endpoint
/websites/streak_readme_io/boxes

### Parameters
#### Query Parameters
- **pipelineKey** (string) - Required - The key of the pipeline to use for creating the box.

#### Request Body
*This endpoint does not require a request body.*

### Request Example
*No request body is sent for this endpoint.*

### Response
#### Success Response (201)
- **box_id** (string) - The unique identifier for the newly created box.

#### Response Example
```json
{
  "box_id": "bx_abcdef123456"
}
```

#### Error Response (400)
- **error** (string) - A message describing the error.

#### Error Response Example
```json
{
  "error": "Invalid pipeline key provided."
}
```
```

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

### Get Meetings in a Box (OpenAPI Definition)

Source: https://streak.readme.io/reference/get-meetings-in-a-box

This OpenAPI 3.1.0 definition describes the API endpoint for retrieving all meetings within a specific box. It includes the server URL, authentication methods, request parameters, and example responses for success (200) and error (400) cases. The `boxKey` is a required path parameter.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "DIRECTORY FIELDS",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.streak.com/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/boxes/{boxKey}/meetings": {
      "get": {
        "summary": "Get all meetings in a box",
        "description": "This call lets you get all meetings in a specific [box](reference#box).",
        "operationId": "get-meetings-in-a-box",
        "parameters": [
          {
            "name": "boxKey",
            "in": "path",
            "description": "The box key for the meetings you'd like to retrieve",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "\"results\": [\n  {\n    \"boxKey\": \"agxzf7aoKDA\",\n    \"pipelineKey\": \"agxzfmICirZaXCgw\",\n    \"orgKey\": \"agxzfzluZUKDA\",\n    \"creatorKey\": \"agxzfmSOhAsM\",\n    \"creationDate\": 1516238421169,\n    \"key\": \"agxzfm1haWxmb\",\n    \"meetingType\": \"CALL_LOG\",\n    \"startTimestamp\": 1541721843765,\n    \"duration\": 240000,\n    \"notes\": \"Dolores is near the end of the maze. Hoping she can solve it before the park is scheduled to open.\"\n    \"lastSavedTimestamp\": 1541721853096\n  }\n]"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

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

### Create Files via API (Python)

Source: https://streak.readme.io/reference/add-files

This snippet shows how to create files using the Streak API v2 with Python's requests library. It defines the API endpoint, constructs the data payload with driveFileId and driveBoxKey, sends a POST request, and prints the response.

```python
import requests

url = "https://www.streak.com/api/v2/files/"
data = [{ "driveFileId": "1mfDH53TbCT7RCs", "driveBoxKey": "agxzfm1haWxmb2" }] 

response = requests.post(url, json=data)

print(response.text)
```

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

### OpenAPI 3.1.0 Specification for Streak API v1

Source: https://streak.readme.io/reference/get-current-user

This JSON document outlines the structure and capabilities of the Streak API version 1. It specifies the base URL, authentication methods (basic HTTP), and the 'Get Current User' endpoint, including its request parameters, response schemas, and example payloads for both success (200) and error (400) cases.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "streak-v1",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.streak.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/users/me": {
      "get": {
        "summary": "Get Current User",
        "description": "Each Streak user has a corresponding user object. Creation of users is done when a user signs up for Streak and these objects can not be altered through the API. Since API keys are associated with the user, each API key only has privileges to access its own user object.",
        "operationId": "get-current-user",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"email\": \"tesla@streak.com\",\n  \"lowercaseEmail\": \"tesla@streak.com\",\n  \"creationTimestamp\": 1347660765134,\n  \"lastUpdatedTimestamp\": 1348463195997,\n  \"lastSeenTimestamp\": 1348470000000,\n  \"isOauthComplete\": true,\n  \"userKey\": \"agptYWlIEVXNlchgBDA\",\n  \"displayName\": \"tesla@streak.com\",\n  \"key\": \"agptYWlIEVXNlchgBDA\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "email": {
                      "type": "string",
                      "example": "tesla@streak.com"
                    },
                    "lowercaseEmail": {
                      "type": "string",
                      "example": "tesla@streak.com"
                    },
                    "creationTimestamp": {
                      "type": "integer",
                      "example": 1347660765134,
                      "default": 0
                    },
                    "lastUpdatedTimestamp": {
                      "type": "integer",
                      "example": 1348463195997,
                      "default": 0
                    },
                    "lastSeenTimestamp": {
                      "type": "integer",
                      "example": 1348470000000,
                      "default": 0
                    },
                    "isOauthComplete": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "userKey": {
                      "type": "string",
                      "example": "agptYWlIEVXNlchgBDA"
                    },
                    "displayName": {
                      "type": "string",
                      "example": "tesla@streak.com"
                    },
                    "key": {
                      "type": "string",
                      "example": "agptYWlIEVXNlchgBDA"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

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

### POST /files/

Source: https://streak.readme.io/reference/add-files

This endpoint allows you to add one or more files from Google Drive to a specific box within Streak. Note that the 'Try it' functionality is not available for this endpoint.

```APIDOC
## POST /files/

### Description
This call lets you add one or more files from Google Drive to a **single box**. Please note that the "Try it" functionality is nonfunctional in this example.

### Method
POST

### Endpoint
https://api.streak.com/api/v2/files/

### Parameters
#### Request Body
- **driveFileId** (string) - Required - The ID from Google Drive that matches a file you're adding
- **driveBoxKey** (string) - Required - The key of the box you'd like to add this file to

### Request Example
```json
{
  "driveFileId": "1YMZjIZKR6o43Zj0d7ni",
  "driveBoxKey": "MfcgxwBTs"
}
```

### Response
#### Success Response (200)
- **fileType** (string) - Type of the file (e.g., "DRIVE").
- **fileOwner** (string) - The owner of the file.
- **creationTimestamp** (integer) - Timestamp when the file was created.
- **lastUpdatedTimestamp** (integer) - Timestamp when the file was last updated.
- **size** (string) - The size of the file.
- **mimeType** (string) - The MIME type of the file.
- **fileName** (string) - The name of the file.
- **mainFileName** (string) - The main name of the file.
- **driveUrl** (string) - The URL to the file in Google Drive.
- **driveFileId** (string) - The ID of the file in Google Drive.
- **driveIconUrl** (string) - The URL for the file's icon.
- **driveOwnerId** (string) - The ID of the file's owner in Google Drive.
- **driveBoxKey** (string) - The key of the box the file belongs to.
- **isCurrentUserOwnerInDrive** (boolean) - Indicates if the current user is the owner in Google Drive.
- **fileKey** (string) - The unique key for the file within Streak.
- **key** (string) - A general key for the resource.
- **boxKey** (string) - The key of the box associated with the file.
- **lastSavedTimestamp** (integer) - Timestamp when the file was last saved.

#### Response Example
```json
[
  {
    "fileType": "DRIVE",
    "fileOwner": "agxzfm1haW",
    "creationTimestamp": 1546470485725,
    "lastUpdatedTimestamp": 1546470485725,
    "size": "0",
    "mimeType": "application/vnd.google-apps.document",
    "fileName": "Bernard Lowe Self-Assessment (Q1'2031)",
    "mainFileName": "Bernard Lowe Self-Assessment (Q1'2031)",
    "driveUrl": "https://drive.google.com/a/file/d/1YMZjIZKR6o43Zj0d7ni",
    "driveFileId": "1YMZjIZKR6o43Zj0d7ni",
    "driveIconUrl": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.document",
    "driveOwnerId": "494833869",
    "driveBoxKey": "MfcgxwBTs",
    "isCurrentUserOwnerInDrive": false,
    "fileKey": "agxzfm1haWxmb29",
    "key": "yLQsSDE9yZ2FuaXphd",
    "boxKey": "yLQsSDE9yZ2FuaXphd",
    "lastSavedTimestamp": 1546470485847
  }
]
```
```

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

### POST /websites/streak_readme_io/add_files

Source: https://streak.readme.io/reference/add-files

Adds one or more files from Google Drive to a single box. The request body should be an array of objects, each containing a `driveBoxKey` and `driveFileId`.

```APIDOC
## POST /websites/streak_readme_io/add_files

### Description
This endpoint allows you to add one or more files from Google Drive to a single box. For each additional file, you must specify the `driveBoxKey` again and pair it with the respective new `driveFileId`.

### Method
POST

### Endpoint
/websites/streak_readme_io/add_files

### Parameters
#### Request Body
- **files** (array) - Required - An array of objects, where each object contains:
  - **driveBoxKey** (string) - Required - The key of the Google Drive box.
  - **driveFileId** (string) - Required - The ID of the file in Google Drive.

### Request Example
```json
{
  "files": [
    {
      "driveBoxKey": "your_box_key_1",
      "driveFileId": "your_file_id_1"
    },
    {
      "driveBoxKey": "your_box_key_1",
      "driveFileId": "your_file_id_2"
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the files were added.

#### Response Example
```json
{
  "message": "Files added successfully to the box."
}
```
```

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

### Get a Field - OpenAPI Definition

Source: https://streak.readme.io/reference/get-a-field

The OpenAPI 3.1.0 definition for the 'Get a field' API endpoint. This specifies the HTTP method, path parameters, request/response schemas, and authentication methods.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "streak-v1",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.streak.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/pipelines/{pipelineKey}/fields/{fieldKey}": {
      "get": {
        "summary": "Get a field",
        "description": "This call lets you get a specific field defined in a [pipeline](reference#getting-a-specific-pipeline).",
        "operationId": "get-a-field",
        "parameters": [
          {
            "name": "pipelineKey",
            "in": "path",
            "description": "The key of the pipeline",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "fieldKey",
            "in": "path",
            "description": "The key of the field",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"name\": \"Start Date\",\n  \"key\": \"1003\",\n  \"type\": \"DATE\"\n} "
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "example": "Start Date"
                    },
                    "key": {
                      "type": "string",
                      "example": "1003"
                    },
                    "type": {
                      "type": "string",
                      "example": "DATE"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

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

### List All Stages in Pipeline

Source: https://streak.readme.io/reference/list-all-stages-in-pipeline

Retrieves a list of all defined stages for a given pipeline. These stages represent the possible states a box can transition through.

```APIDOC
## GET /pipelines/{pipelineId}/stages

### Description
Lists all stages defined in a pipeline. These stages represent the possible states a box can be in. To change the stage of a box, use the edit box endpoint and update the `stageKey` property.

### Method
GET

### Endpoint
/pipelines/{pipelineId}/stages

### Parameters
#### Path Parameters
- **pipelineId** (string) - Required - The unique identifier of the pipeline for which to list stages.

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **stages** (array) - A list of stage objects.
  - **key** (string) - The unique identifier for the stage.
  - **name** (string) - The display name of the stage.
  - **isDefault** (boolean) - Indicates if this is the default stage for the pipeline.
  - **order** (integer) - The order in which stages are displayed.

#### Response Example
```json
{
  "stages": [
    {
      "key": "new",
      "name": "New",
      "isDefault": true,
      "order": 0
    },
    {
      "key": "in_progress",
      "name": "In Progress",
      "isDefault": false,
      "order": 1
    },
    {
      "key": "completed",
      "name": "Completed",
      "isDefault": false,
      "order": 2
    }
  ]
}
```
```

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

### Get all meetings in a box

Source: https://streak.readme.io/reference/get-meetings-in-a-box

Retrieves all meetings associated with a specific box. Requires authentication.

```APIDOC
## GET /boxes/{boxKey}/meetings

### Description
This call lets you get all meetings in a specific [box](reference#box).

### Method
GET

### Endpoint
https://api.streak.com/api/v2/boxes/{boxKey}/meetings

### Parameters
#### Path Parameters
- **boxKey** (string) - Required - The box key for the meetings you'd like to retrieve

### Request Example
```json
{
  "example": "Not applicable for GET request"
}
```

### Response
#### Success Response (200)
- **results** (array) - An array of meeting objects.
  - **boxKey** (string) - The key of the box the meeting belongs to.
  - **pipelineKey** (string) - The key of the pipeline the meeting is associated with.
  - **orgKey** (string) - The key of the organization.
  - **creatorKey** (string) - The key of the user who created the meeting.
  - **creationDate** (integer) - The timestamp when the meeting was created.
  - **key** (string) - The unique key of the meeting.
  - **meetingType** (string) - The type of meeting (e.g., "CALL_LOG").
  - **startTimestamp** (integer) - The timestamp when the meeting started.
  - **duration** (integer) - The duration of the meeting in milliseconds.
  - **notes** (string) - Notes associated with the meeting.
  - **lastSavedTimestamp** (integer) - The timestamp when the meeting was last saved.

#### Response Example
```json
{
  "results": [
    {
      "boxKey": "agxzf7aoKDA",
      "pipelineKey": "agxzfmICirZaXCgw",
      "orgKey": "agxzfzluZUKDA",
      "creatorKey": "agxzfmSOhAsM",
      "creationDate": 1516238421169,
      "key": "agxzfm1haWxmb",
      "meetingType": "CALL_LOG",
      "startTimestamp": 1541721843765,
      "duration": 240000,
      "notes": "Dolores is near the end of the maze. Hoping she can solve it before the park is scheduled to open.",
      "lastSavedTimestamp": 1541721853096
    }
  ]
}
```
```

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

### Create Files via API (cURL)

Source: https://streak.readme.io/reference/add-files

This snippet demonstrates how to create files using the Streak API v2 via cURL. It specifies the POST request method, the API endpoint URL, the required Content-Type header, and the JSON payload containing driveBoxKey and driveFileId.

```curl
curl --request POST \
	--url https://www.streak.com/api/v2/files/ \
	-H "Content-Type: application/json" \
	-d '[{"driveBoxKey": "agxzfm1haWxmb2", "driveFileId": "1mfDH53TbCT7RCs"}]'
```

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

### GET /boxes/{boxKey}/comments

Source: https://streak.readme.io/reference/get-all-comments

Retrieves all comments associated with a specific box. Requires authentication.

```APIDOC
## GET /boxes/{boxKey}/comments

### Description
This call lets you get all comments in a specific [box](reference#box).

### Method
GET

### Endpoint
/boxes/{boxKey}/comments

### Parameters
#### Path Parameters
- **boxKey** (string) - Required - The box key for the comments you'd like to retrieve

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **hasNextPage** (boolean) - Indicates if there are more pages of results.
- **results** (array) - An array of comment objects.
  - **boxKey** (string) - The key of the box the comment belongs to.
  - **pipelineKey** (string) - The key of the pipeline the comment belongs to.
  - **creatorKey** (string) - The key of the user who created the comment.
  - **newsfeedEntryKey** (string) - The key of the newsfeed entry associated with the comment.
  - **timestamp** (integer) - The timestamp when the comment was created.
  - **message** (string) - The content of the comment.
  - **commentKey** (string) - The unique key of the comment.
  - **key** (string) - An alias for commentKey.
  - **lastSavedTimestamp** (integer) - The timestamp when the comment was last saved.

#### Response Example
```json
{
  "hasNextPage": false,
  "results": [
    {
      "boxKey": "yNAsSDE9yZ2FuaXphdGlvb",
      "pipelineKey": "agxzfm1haW",
      "creatorKey": "agxzfm1haW",
      "newsfeedEntryKey": "ffSDU5ld3NmZWVkRW50",
      "timestamp": 1557856962657,
      "message": "Yeah, yeah, indubitably, yeah.",
      "commentKey": "agxzfm1haW",
      "key": "agxzfm1haW",
      "lastSavedTimestamp": 1557856962736
    }
  ]
}
```

#### Error Response (400)
- **(empty object)** - Indicates a bad request.

#### Error Response Example
```json
{
  "example": "{}"
}
```
```

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

### POST /pipelines/{pipelineKey}/boxes

Source: https://streak.readme.io/reference/create-a-box

Creates a new box within a specified pipeline. You can provide a name, stage, notes, and assign team members to the box.

```APIDOC
## POST /pipelines/{pipelineKey}/boxes

### Description
This call creates a [box](reference#get-a-box) based on the pipelineKey you provide.

### Method
POST

### Endpoint
https://api.streak.com/api/v2/pipelines/{pipelineKey}/boxes

### Parameters
#### Path Parameters
- **pipelineKey** (string) - Required - The key of the pipeline this box should belong to

#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of this box
- **stageKey** (string) - Optional - The stage of this box
- **notes** (string) - Optional - The notes on the box
- **assignedToSharingEntries** (string) - Optional - The member(s) of your team this box will be assigned to. This must be an array of objects with `email` properties encoded as a JSON string. Try this as an example: `[{"email":"ginny@weasley.com"}, {"email":"fred@weasley.com"}, {"email":"george@weasley.com"}]'`, keeping in mind that any assigned-to users must have access to the pipeline.

### Request Example
```json
{
  "name": "NewBox",
  "stageKey": "5001",
  "notes": "Some important notes.",
  "assignedToSharingEntries": "[\"{\\\"email\\\":\\\"ginny@weasley.com\\\"}\", \"{\\\"email\\\":\\\"fred@weasley.com\\\"}\", \"{\\\"email\\\":\\\"george@weasley.com\\\"}\"]"
}
```

### Response
#### Success Response (200)
- **pipelineKey** (string) - The key of the pipeline the box belongs to.
- **creatorKey** (string) - The key of the user who created the box.
- **creationTimestamp** (integer) - The timestamp when the box was created.
- **lastUpdatedTimestamp** (integer) - The timestamp when the box was last updated.
- **name** (string) - The name of the box.
- **stageKey** (string) - The key of the stage the box is in.
- **fields** (object) - An object containing custom fields for the box.
- **followerKeys** (array) - An array of keys for users following the box.
- **followerCount** (integer) - The number of users following the box.
- **commentCount** (integer) - The number of comments on the box.
- **taskTotal** (integer) - The total number of tasks associated with the box.
- **gmailThreadCount** (integer) - The number of Gmail threads linked to the box.
- **fileCount** (integer) - The number of files attached to the box.
- **boxKey** (string) - The unique key of the box.
- **key** (string) - An alias for boxKey.

#### Response Example
```json
{
  "pipelineKey": "agptYWl3cYPww",
  "creatorKey": "agptXNlchgBDA",
  "creationTimestamp": 1348436318347,
  "lastUpdatedTimestamp": 1348436318347,
  "name": "NewBox",
  "stageKey": "5001",
  "fields": {},
  "followerKeys": ["agptXNlchgBDA"],
  "followerCount": 1,
  "commentCount": 0,
  "taskTotal": 0,
  "gmailThreadCount": 1,
  "fileCount": 0,
  "boxKey": "agptYWRiZAQw",
  "key": "agptYWRiZAQw"
}
```
```

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

### GET /comments/{commentKey}

Source: https://streak.readme.io/reference/get-a-comment

Retrieves a specific comment using its unique key. This endpoint is useful for fetching detailed information about a particular comment.

```APIDOC
## GET /comments/{commentKey}

### Description
This call lets you get all a specific [comment](reference#comments).

### Method
GET

### Endpoint
https://api.streak.com/api/v2/comments/{commentKey}

### Parameters
#### Path Parameters
- **commentKey** (string) - Required - The comment key for the comment you'd like to retrieve

### Request Example
```json
{
  "example": "No request body needed for this GET request."
}
```

### Response
#### Success Response (200)
- **boxKey** (string) - The key of the box the comment belongs to.
- **pipelineKey** (string) - The key of the pipeline the comment belongs to.
- **creatorKey** (string) - The key of the user who created the comment.
- **newsfeedEntryKey** (string) - The key of the newsfeed entry associated with the comment.
- **timestamp** (integer) - The timestamp when the comment was created.
- **message** (string) - The content of the comment.
- **commentKey** (string) - The unique key of the comment.
- **key** (string) - An alias for commentKey.
- **lastSavedTimestamp** (integer) - The timestamp when the comment was last saved.

#### Response Example
```json
{
  "boxKey": "agxzf7aoKDA",
  "pipelineKey": "agxzfmICirZaXCgw",
  "creatorKey": "agxzfzluZUKDA",
  "newsfeedEntryKey": "agxzfmSOhAsM",
  "timestamp": 1516238421169,
  "message": "do you feel lucky?",
  "commentKey": "agxzfm1nPtqsKDA",
  "key": "agxzfm1nPtqsKDA",
  "lastSavedTimestamp": 1516238545102
}
```
```

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

### GET /pipelines/{pipelineKey}/stages

Source: https://streak.readme.io/reference/list-all-stages-in-pipeline

Retrieves a list of all stages defined within a specific pipeline. Stages represent the possible states a box can be in, and are configured at the pipeline level.

```APIDOC
## GET /pipelines/{pipelineKey}/stages

### Description
Lists all stages defined in a pipeline. Stages are different possible states a box can be in. The list of valid stages a box can be in are defined in the pipeline it belongs to. All boxes in the same pipeline all have the same set of permissible stages. Listing the stages for a given pipeline can be done by getting a specific pipeline or using this endpoint.

To change what stage a box is in, update the `stageKey` property of a box using the edit box endpoint.

### Method
GET

### Endpoint
/pipelines/{pipelineKey}/stages

### Parameters
#### Path Parameters
- **pipelineKey** (string) - Required - The key of the pipeline

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **name** (string) - The name of the stage.
- **key** (string) - The unique identifier for the stage.

#### Response Example
```json
{
  "5002": {
    "name": "Phone Screen",
    "key": "5002"
  },
  "5001": {
    "name": "Resume",
    "key": "5001"
  },
  "5003": {
    "name": "Interview",
    "key": "5003"
  },
  "5007": {
    "name": "Passed",
    "key": "5007"
  },
  "5005": {
    "name": "Offer Negotiation",
    "key": "5005"
  },
  "5006": {
    "name": "Hired",
    "key": "5006"
  }
}
```
```

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

### Get a Field

Source: https://streak.readme.io/reference/get-a-field

Retrieves the details of a specific field within a given pipeline. This endpoint allows you to fetch information about a field using its unique key and the pipeline's key.

```APIDOC
## GET /pipelines/{pipelineKey}/fields/{fieldKey}

### Description
This call lets you get a specific field defined in a [pipeline](reference#getting-a-specific-pipeline).

### Method
GET

### Endpoint
/pipelines/{pipelineKey}/fields/{fieldKey}

### Parameters
#### Path Parameters
- **pipelineKey** (string) - Required - The key of the pipeline
- **fieldKey** (string) - Required - The key of the field

### Request Example
```json
{
  "example": "No request body needed for this GET request."
}
```

### Response
#### Success Response (200)
- **name** (string) - The name of the field
- **key** (string) - The unique key of the field
- **type** (string) - The type of the field (e.g., DATE)

#### Response Example
```json
{
  "name": "Start Date",
  "key": "1003",
  "type": "DATE"
}
```
```
Tokens:
Raw