Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Fixed
- Fixed the comma-separated `include_fields` query parameter across v2 collection/detail endpoints (`GET /api/v2/activities`, `GET /api/v2/activities/{id}`, `GET /api/v2/activityFields`, `GET /api/v2/activityFields/{field_code}`, `GET /api/v2/deals`, `GET /api/v2/deals/{id}`, `GET /api/v2/dealFields`, `GET /api/v2/dealFields/{field_code}`, `GET /api/v2/organizations`, `GET /api/v2/organizations/{id}`, `GET /api/v2/organizationFields`, `GET /api/v2/organizationFields/{field_code}`, `GET /api/v2/persons`, `GET /api/v2/persons/{id}`, `GET /api/v2/personFields`, `GET /api/v2/personFields/{field_code}`, `GET /api/v2/productFields`, and `GET /api/v2/productFields/{field_code}`) that was typed as `type: string` with an enum of comma-joined value combinations despite accepting comma-separated lists — changed to `type: array` of enumerated strings with `uniqueItems: true`, `style: form`, `explode: false`
- Fixed the comma-separated `custom_fields` query parameter on v2 collection/detail endpoints (`GET /api/v2/deals`, `GET /api/v2/deals/archived`, `GET /api/v2/deals/{id}`, `GET /api/v2/organizations`, `GET /api/v2/organizations/{id}`, `GET /api/v2/persons`, `GET /api/v2/persons/{id}`, and `GET /api/v2/products`) and the `ids` query parameter on v2 collection endpoints (`GET /api/v2/activities`, `GET /api/v2/deals`, `GET /api/v2/deals/archived`, `GET /api/v2/organizations`, `GET /api/v2/persons`, and `GET /api/v2/products`) that were typed as `type: string` despite accepting comma-separated lists — changed to `type: array` of strings (`custom_fields` capped at 15 items, `ids` at 100) with `uniqueItems: true`, `style: form`, `explode: false`

## [17.6.0](https://github.com/pipedrive/client-php/compare17.5.2...17.6.0) (2026-09-08)
### Added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**id** | **int** | The ID of the deal creator | [optional]
**name** | **string** | The name of the deal creator | [optional]
**email** | **string** | The email of the deal creator | [optional]
**has_pic** | **bool** | If the creator has a picture or not | [optional]
**has_pic** | **int** | If the creator has a picture or not | [optional]
**pic_hash** | **string** | The creator picture hash | [optional]
**active_flag** | **bool** | Whether the creator is active or not | [optional]
**value** | **int** | The ID of the deal creator | [optional]
Expand Down
12 changes: 6 additions & 6 deletions docs/versions/v2/Api/ActivitiesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ActivitiesApi(
$config
);
$filter_id = 56; // int | If supplied, only activities matching the specified filter are returned
$ids = 'ids_example'; // string | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
$ids = array('ids_example'); // string[] | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
$owner_id = 56; // int | If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
$deal_id = 56; // int | If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
$lead_id = 'lead_id_example'; // string | If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
Expand All @@ -185,7 +185,7 @@ $updated_since = 'updated_since_example'; // string | If set, only activities wi
$updated_until = 'updated_until_example'; // string | If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
$sort_by = 'id'; // string | The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
$sort_direction = 'asc'; // string | The sorting direction. Supported values: `asc`, `desc`.
$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional fields to include
$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include
$limit = 100; // int | 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.
$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page

Expand All @@ -202,7 +202,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter_id** | **int**| If supplied, only activities matching the specified filter are returned | [optional]
**ids** | **string**| Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. | [optional]
**ids** | [**string[]**](../Model/string.md)| Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. | [optional]
**owner_id** | **int**| If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. | [optional]
**deal_id** | **int**| If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. | [optional]
**lead_id** | **string**| If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. | [optional]
Expand All @@ -213,7 +213,7 @@ Name | Type | Description | Notes
**updated_until** | **string**| If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. | [optional]
**sort_by** | **string**| The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. | [optional] [default to 'id']
**sort_direction** | **string**| The sorting direction. Supported values: `asc`, `desc`. | [optional] [default to 'asc']
**include_fields** | **string**| Optional comma separated string array of additional fields to include | [optional]
**include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]
**limit** | **int**| 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. | [optional]
**cursor** | **string**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]

Expand Down Expand Up @@ -267,7 +267,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ActivitiesApi(
$config
);
$id = 56; // int | The ID of the activity
$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional fields to include
$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include

try {
$result = $apiInstance->getActivity($id, $include_fields);
Expand All @@ -282,7 +282,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The ID of the activity |
**include_fields** | **string**| Optional comma separated string array of additional fields to include | [optional]
**include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]

### Return type

Expand Down
8 changes: 4 additions & 4 deletions docs/versions/v2/Api/ActivityFieldsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ActivityFieldsApi(
$config
);
$field_code = 'field_code_example'; // string | The unique code identifying the field
$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional data namespaces to include in response

try {
$result = $apiInstance->getActivityField($field_code, $include_fields);
Expand All @@ -56,7 +56,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**field_code** | **string**| The unique code identifying the field |
**include_fields** | **string**| Optional comma separated string array of additional data namespaces to include in response | [optional]
**include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional data namespaces to include in response | [optional]

### Return type

Expand Down Expand Up @@ -107,7 +107,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ActivityFieldsApi(
new GuzzleHttp\Client(),
$config
);
$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional data namespaces to include in response
$limit = 100; // int | 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.
$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page

Expand All @@ -123,7 +123,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**include_fields** | **string**| Optional comma separated string array of additional data namespaces to include in response | [optional]
**include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional data namespaces to include in response | [optional]
**limit** | **int**| 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. | [optional]
**cursor** | **string**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]

Expand Down
8 changes: 4 additions & 4 deletions docs/versions/v2/Api/DealFieldsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\DealFieldsApi(
$config
);
$field_code = 'field_code_example'; // string | The unique code identifying the field
$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional data namespaces to include in response

try {
$result = $apiInstance->getDealField($field_code, $include_fields);
Expand All @@ -326,7 +326,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**field_code** | **string**| The unique code identifying the field |
**include_fields** | **string**| Optional comma separated string array of additional data namespaces to include in response | [optional]
**include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional data namespaces to include in response | [optional]

### Return type

Expand Down Expand Up @@ -377,7 +377,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\DealFieldsApi(
new GuzzleHttp\Client(),
$config
);
$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional data namespaces to include in response
$limit = 100; // int | 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.
$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page

Expand All @@ -393,7 +393,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**include_fields** | **string**| Optional comma separated string array of additional data namespaces to include in response | [optional]
**include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional data namespaces to include in response | [optional]
**limit** | **int**| 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. | [optional]
**cursor** | **string**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]

Expand Down
Loading