{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pipedrive API v1 Activities Beta API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Beta",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all project fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/projectFields",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns metadata about all project fields in the company."
        },
        {
          "info": {
            "name": "Create one project field",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/projectFields",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Creates a new project custom field."
        },
        {
          "info": {
            "name": "Get one project field",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/projectFields/:field_code",
            "params": [
              {
                "name": "field_code",
                "value": "",
                "type": "path",
                "description": "The unique code identifying the field"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns metadata about a specific project field."
        },
        {
          "info": {
            "name": "Update one project field",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/projectFields/:field_code",
            "params": [
              {
                "name": "field_code",
                "value": "",
                "type": "path",
                "description": "The unique code identifying the field"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates a project custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body."
        },
        {
          "info": {
            "name": "Delete one project field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/projectFields/:field_code",
            "params": [
              {
                "name": "field_code",
                "value": "",
                "type": "path",
                "description": "The unique code identifying the field"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Marks a custom field as deleted."
        },
        {
          "info": {
            "name": "Add project field options in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/projectFields/:field_code/options",
            "params": [
              {
                "name": "field_code",
                "value": "",
                "type": "path",
                "description": "The unique code identifying the field"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds new options to a project custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options."
        },
        {
          "info": {
            "name": "Update project field options in bulk",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/projectFields/:field_code/options",
            "params": [
              {
                "name": "field_code",
                "value": "",
                "type": "path",
                "description": "The unique code identifying the field"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates existing options for a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options."
        },
        {
          "info": {
            "name": "Delete project field options in bulk",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/projectFields/:field_code/options",
            "params": [
              {
                "name": "field_code",
                "value": "",
                "type": "path",
                "description": "The unique code identifying the field"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Removes existing options from a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options."
        },
        {
          "info": {
            "name": "Search projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/projects/search",
            "params": [
              {
                "name": "term",
                "value": "",
                "type": "query",
                "description": "The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>."
              },
              {
                "name": "exact_match",
                "value": "",
                "type": "query",
                "description": "When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive."
              },
              {
                "name": "person_id",
                "value": "",
                "type": "query",
                "description": "Will filter projects by the provided person ID"
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "Will filter projects by the provided organization ID"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID."
        },
        {
          "info": {
            "name": "Get all tasks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/tasks",
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
              },
              {
                "name": "is_done",
                "value": "",
                "type": "query",
                "description": "Whether the task is done or not. If omitted, both done and not done tasks are returned."
              },
              {
                "name": "is_milestone",
                "value": "",
                "type": "query",
                "description": "Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned."
              },
              {
                "name": "assignee_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only tasks assigned to this user are returned"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only tasks belonging to this project are returned"
              },
              {
                "name": "parent_task_id",
                "value": "",
                "type": "query",
                "description": "If `null` is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns all tasks."
        },
        {
          "info": {
            "name": "Add a task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/tasks",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a new task."
        },
        {
          "info": {
            "name": "Get details of a task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/tasks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the task"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns the details of a specific task."
        },
        {
          "info": {
            "name": "Update a task",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/tasks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the task"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates a task."
        },
        {
          "info": {
            "name": "Delete a task",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/tasks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the task"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Marks a task as deleted. If the task has subtasks, those will also be deleted."
        },
        {
          "info": {
            "name": "Get all project boards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/boards",
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns all active project boards."
        },
        {
          "info": {
            "name": "Add a project board",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/boards",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a new project board."
        },
        {
          "info": {
            "name": "Get details of a project board",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/boards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the project board"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns the details of a specific project board."
        },
        {
          "info": {
            "name": "Update a project board",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/boards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the project board"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates the properties of a project board."
        },
        {
          "info": {
            "name": "Delete a project board",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/boards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the project board"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Marks a project board as deleted."
        },
        {
          "info": {
            "name": "Get project phases",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/phases",
            "params": [
              {
                "name": "board_id",
                "value": "",
                "type": "query",
                "description": "The ID of the board for which phases are requested"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns all active project phases under a specific board."
        },
        {
          "info": {
            "name": "Add a project phase",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/phases",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a new project phase to a board."
        },
        {
          "info": {
            "name": "Get details of a project phase",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/phases/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the project phase"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns the details of a specific project phase."
        },
        {
          "info": {
            "name": "Update a project phase",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/phases/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the project phase"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates the properties of a project phase."
        },
        {
          "info": {
            "name": "Delete a project phase",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/phases/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the project phase"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Marks a project phase as deleted."
        }
      ]
    }
  ],
  "bundled": true
}