All URIs are relative to https://api.pipedrive.com/v1.
Method | HTTP request | Description |
---|---|---|
addProject() | POST /projects | Add a project |
archiveProject() | POST /projects/{id}/archive | Archive a project |
deleteProject() | DELETE /projects/{id} | Delete a project |
getProject() | GET /projects/{id} | Get details of a project |
getProjectActivities() | GET /projects/{id}/activities | Returns project activities |
getProjectGroups() | GET /projects/{id}/groups | Returns project groups |
getProjectPlan() | GET /projects/{id}/plan | Returns project plan |
getProjectTasks() | GET /projects/{id}/tasks | Returns project tasks |
getProjects() | GET /projects | Get all projects |
getProjectsBoards() | GET /projects/boards | Get all project boards |
getProjectsPhases() | GET /projects/phases | Get project phases |
putProjectPlanActivity() | PUT /projects/{id}/plan/activities/{activityId} | Update activity in project plan |
putProjectPlanTask() | PUT /projects/{id}/plan/tasks/{taskId} | Update task in project plan |
updateProject() | PUT /projects/{id} | Update a project |
addProject($project_post_object): \Pipedrive\Model\AddProjectResponse201
Add a project
Adds a new project. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$project_post_object = new \Pipedrive\Model\ProjectPostObject(); // \Pipedrive\Model\ProjectPostObject
try {
$result = $apiInstance->addProject($project_post_object);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addProject: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_post_object | \Pipedrive\Model\ProjectPostObject | [optional] |
\Pipedrive\Model\AddProjectResponse201
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
archiveProject($id): \Pipedrive\Model\UpdateProjectResponse200
Archive a project
Archives a project.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
try {
$result = $apiInstance->archiveProject($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->archiveProject: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project |
\Pipedrive\Model\UpdateProjectResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteProject($id): \Pipedrive\Model\DeleteProjectResponse200
Delete a project
Marks a project as deleted.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
try {
$result = $apiInstance->deleteProject($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project |
\Pipedrive\Model\DeleteProjectResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getProject($id): \Pipedrive\Model\GetProjectResponse200
Get details of a project
Returns the details of a specific project. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the key
value of project fields.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
try {
$result = $apiInstance->getProject($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getProject: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project |
\Pipedrive\Model\GetProjectResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getProjectActivities($id): \Pipedrive\Model\GetActivitiesCollectionResponse200
Returns project activities
Returns activities linked to a specific project.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
try {
$result = $apiInstance->getProjectActivities($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getProjectActivities: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project |
\Pipedrive\Model\GetActivitiesCollectionResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getProjectGroups($id): \Pipedrive\Model\GetProjectGroupsResponse200
Returns project groups
Returns all active groups under a specific project.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
try {
$result = $apiInstance->getProjectGroups($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getProjectGroups: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project |
\Pipedrive\Model\GetProjectGroupsResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getProjectPlan($id): \Pipedrive\Model\GetProjectPlanResponse200
Returns project plan
Returns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
try {
$result = $apiInstance->getProjectPlan($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getProjectPlan: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project |
\Pipedrive\Model\GetProjectPlanResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getProjectTasks($id): \Pipedrive\Model\GetTasksResponse200
Returns project tasks
Returns tasks linked to a specific project.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
try {
$result = $apiInstance->getProjectTasks($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getProjectTasks: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project |
\Pipedrive\Model\GetTasksResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getProjects($cursor, $limit, $filter_id, $status, $phase_id, $include_archived): \Pipedrive\Model\GetProjectsResponse200
Get all projects
Returns all projects. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target="_blank" rel="noopener noreferrer">pagination.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
$limit = 100; // int | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
$filter_id = 56; // int | The ID of the filter to use
$status = open,completed; // string | If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
$phase_id = 56; // int | If supplied, only projects in specified phase are returned
$include_archived = True; // bool | If supplied with `true` then archived projects are also included in the response. By default only not archived projects are returned.
try {
$result = $apiInstance->getProjects($cursor, $limit, $filter_id, $status, $phase_id, $include_archived);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getProjects: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
cursor | string | For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] |
limit | int | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. | [optional] |
filter_id | int | The ID of the filter to use | [optional] |
status | string | If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned. | [optional] |
phase_id | int | If supplied, only projects in specified phase are returned | [optional] |
include_archived | bool | If supplied with `true` then archived projects are also included in the response. By default only not archived projects are returned. | [optional] |
\Pipedrive\Model\GetProjectsResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getProjectsBoards(): \Pipedrive\Model\GetProjectBoardsResponse200
Get all project boards
Returns all projects boards that are not deleted.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getProjectsBoards();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getProjectsBoards: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
\Pipedrive\Model\GetProjectBoardsResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getProjectsPhases($board_id): \Pipedrive\Model\GetProjectPhasesResponse200
Get project phases
Returns all active project phases under a specific board.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$board_id = 1; // int | ID of the board for which phases are requested
try {
$result = $apiInstance->getProjectsPhases($board_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getProjectsPhases: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
board_id | int | ID of the board for which phases are requested |
\Pipedrive\Model\GetProjectPhasesResponse200
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
putProjectPlanActivity($id, $activity_id, $project_put_plan_item_body_object): \Pipedrive\Model\UpdatedActivityPlanItem200
Update activity in project plan
Updates an activity phase or group in a project.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
$activity_id = 56; // int | The ID of the activity
$project_put_plan_item_body_object = new \Pipedrive\Model\ProjectPutPlanItemBodyObject(); // \Pipedrive\Model\ProjectPutPlanItemBodyObject
try {
$result = $apiInstance->putProjectPlanActivity($id, $activity_id, $project_put_plan_item_body_object);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->putProjectPlanActivity: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project | |
activity_id | int | The ID of the activity | |
project_put_plan_item_body_object | \Pipedrive\Model\ProjectPutPlanItemBodyObject | [optional] |
\Pipedrive\Model\UpdatedActivityPlanItem200
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
putProjectPlanTask($id, $task_id, $project_put_plan_item_body_object): \Pipedrive\Model\UpdatedTaskPlanItem200
Update task in project plan
Updates a task phase or group in a project.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
$task_id = 56; // int | The ID of the task
$project_put_plan_item_body_object = new \Pipedrive\Model\ProjectPutPlanItemBodyObject(); // \Pipedrive\Model\ProjectPutPlanItemBodyObject
try {
$result = $apiInstance->putProjectPlanTask($id, $task_id, $project_put_plan_item_body_object);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->putProjectPlanTask: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project | |
task_id | int | The ID of the task | |
project_put_plan_item_body_object | \Pipedrive\Model\ProjectPutPlanItemBodyObject | [optional] |
\Pipedrive\Model\UpdatedTaskPlanItem200
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateProject($id, $project_put_object): \Pipedrive\Model\UpdateProjectResponse200
Update a project
Updates a project.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Pipedrive\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | The ID of the project
$project_put_object = new \Pipedrive\Model\ProjectPutObject(); // \Pipedrive\Model\ProjectPutObject
try {
$result = $apiInstance->updateProject($id, $project_put_object);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->updateProject: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The ID of the project | |
project_put_object | \Pipedrive\Model\ProjectPutObject | [optional] |
\Pipedrive\Model\UpdateProjectResponse200
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]