Skip to content
Merged
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
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,41 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

## [14.5.0](https://github.com/pipedrive/client-php/compare/14.4.0...14.5.0) (2025-12-02)

### Added
- Documented the following new v2 endpoints:
- `GET /api/v2/activityFields`
- `GET /api/v2/dealFields`
- `GET /api/v2/organizationFields`
- `GET /api/v2/personFields`
- `GET /api/v2/productFields`
- `GET /api/v2/activityFields/{field_code}`
- `GET /api/v2/dealFields/{field_code}`
- `GET /api/v2/organizationFields/{field_code}`
- `GET /api/v2/personFields/{field_code}`
- `GET /api/v2/productFields/{field_code}`
- `POST /api/v2/dealFields`
- `POST /api/v2/organizationFields`
- `POST /api/v2/personFields`
- `POST /api/v2/productFields`
- `DELETE /api/v2/dealFields/{field_code}`
- `DELETE /api/v2/organizationFields/{field_code}`
- `DELETE /api/v2/personFields/{field_code}`
- `DELETE /api/v2/productFields/{field_code}`
- `POST /api/v2/dealFields/{field_code}/options`
- `POST /api/v2/organizationFields/{field_code}/options`
- `POST /api/v2/personFields/{field_code}/options`
- `POST /api/v2/productFields/{field_code}/options`
- `PATCH /api/v2/dealFields/{field_code}/options`
- `PATCH /api/v2/organizationFields/{field_code}/options`
- `PATCH /api/v2/personFields/{field_code}/options`
- `PATCH /api/v2/productFields/{field_code}/options`
- `DELETE /api/v2/dealFields/{field_code}/options`
- `DELETE /api/v2/organizationFields/{field_code}/options`
- `DELETE /api/v2/personFields/{field_code}/options`
- `DELETE /api/v2/productFields/{field_code}/options`

## [14.4.0](https://github.com/pipedrive/client-php/compare/14.3.3...14.4.0) (2025-11-25)

### Fixed
Expand Down
145 changes: 145 additions & 0 deletions docs/versions/v2/Api/ActivityFieldsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Pipedrive\versions\v2\ActivityFieldsApi

All URIs are relative to https://api.pipedrive.com/api/v2.

Method | HTTP request | Description
------------- | ------------- | -------------
[**getActivityField()**](ActivityFieldsApi.md#getActivityField) | **GET** /activityFields/{field_code} | Get one activity field
[**getActivityFields()**](ActivityFieldsApi.md#getActivityFields) | **GET** /activityFields | Get all activity fields


## `getActivityField()`

```php
getActivityField($field_code, $include_fields): \Pipedrive\versions\v2\Model\GetActivityField
```

Get one activity field

Returns metadata about a specific activity field.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ActivityFieldsApi(
// 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
);
$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

try {
$result = $apiInstance->getActivityField($field_code, $include_fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ActivityFieldsApi->getActivityField: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

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]

### Return type

[**\Pipedrive\versions\v2\Model\GetActivityField**](../Model/GetActivityField.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)

## `getActivityFields()`

```php
getActivityFields($include_fields, $limit, $cursor): \Pipedrive\versions\v2\Model\GetActivityFields
```

Get all activity fields

Returns metadata about all activity fields in the company.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ActivityFieldsApi(
// 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
);
$include_fields = '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

try {
$result = $apiInstance->getActivityFields($include_fields, $limit, $cursor);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ActivityFieldsApi->getActivityFields: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**include_fields** | **string**| 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]

### Return type

[**\Pipedrive\versions\v2\Model\GetActivityFields**](../Model/GetActivityFields.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
Loading