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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ 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]
### Added
- Added `GET /api/v2/persons/{id}/picture` endpoint to retrieve picture information for a specific person, including ID, file size, and URLs for both 128x128 (thumbnail) and 512x512 (full-size) versions of the person's profile picture

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

Expand Down
66 changes: 66 additions & 0 deletions docs/versions/v2/Api/PersonsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Method | HTTP request | Description
[**getPerson()**](PersonsApi.md#getPerson) | **GET** /persons/{id} | Get details of a person
[**getPersonFollowers()**](PersonsApi.md#getPersonFollowers) | **GET** /persons/{id}/followers | List followers of a person
[**getPersonFollowersChangelog()**](PersonsApi.md#getPersonFollowersChangelog) | **GET** /persons/{id}/followers/changelog | List followers changelog of a person
[**getPersonPicture()**](PersonsApi.md#getPersonPicture) | **GET** /persons/{id}/picture | Get picture of a person
[**getPersons()**](PersonsApi.md#getPersons) | **GET** /persons | Get all persons
[**searchPersons()**](PersonsApi.md#searchPersons) | **GET** /persons/search | Search persons
[**updatePerson()**](PersonsApi.md#updatePerson) | **PATCH** /persons/{id} | Update a person
Expand Down Expand Up @@ -487,6 +488,71 @@ Name | Type | Description | Notes
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)

## `getPersonPicture()`

```php
getPersonPicture($id): \Pipedrive\versions\v2\Model\PersonPictureResponse
```

Get picture of a person

Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.

### 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\PersonsApi(
// 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 person

try {
$result = $apiInstance->getPersonPicture($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PersonsApi->getPersonPicture: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The ID of the person |

### Return type

[**\Pipedrive\versions\v2\Model\PersonPictureResponse**](../Model/PersonPictureResponse.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)

## `getPersons()`

```php
Expand Down
1 change: 1 addition & 0 deletions docs/versions/v2/Model/ActivityItemLocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**sublocality** | **string** | Sublocality (e.g. neighborhood) of the activity | [optional]
**route** | **string** | Route (e.g. street) of the activity | [optional]
**street_number** | **string** | Street number of the activity | [optional]
**subpremise** | **string** | Subpremise (e.g. apartment/suite number) of the activity | [optional]
**postal_code** | **string** | Postal code of the activity | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1 change: 1 addition & 0 deletions docs/versions/v2/Model/OrganizationItemAddress.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**sublocality** | **string** | Sublocality (e.g. neighborhood) of the organization | [optional]
**route** | **string** | Route (e.g. street) of the organization | [optional]
**street_number** | **string** | Street number of the organization | [optional]
**subpremise** | **string** | Subpremise (e.g. apartment/suite number) of the organization | [optional]
**postal_code** | **string** | Postal code of the organization | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1 change: 1 addition & 0 deletions docs/versions/v2/Model/PersonItemPostalAddress.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**sublocality** | **string** | Sublocality (e.g. neighborhood) of the person | [optional]
**route** | **string** | Route (e.g. street) of the person | [optional]
**street_number** | **string** | Street number of the person | [optional]
**subpremise** | **string** | Subpremise (e.g. apartment/suite number) of the person | [optional]
**postal_code** | **string** | Postal code of the person | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 changes: 15 additions & 0 deletions docs/versions/v2/Model/PersonPictureItem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# # PersonPictureItem

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | The ID of the picture. | [optional]
**item_type** | **string** | The type of item the picture is associated with. | [optional]
**item_id** | **int** | The ID of the person this picture belongs to. | [optional]
**added_by_user_id** | **int** | The ID of the user who added the picture. | [optional]
**active_flag** | **bool** | Whether the picture is active or not. | [optional]
**file_size** | **int** | The file size in bytes. | [optional]
**pictures** | [**\Pipedrive\versions\v2\Model\PersonPictureItemPictures**](PersonPictureItemPictures.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 changes: 10 additions & 0 deletions docs/versions/v2/Model/PersonPictureItemPictures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # PersonPictureItemPictures

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_128** | **string** | The URL of the 128x128 picture. | [optional]
**_512** | **string** | The URL of the 512x512 picture. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 changes: 10 additions & 0 deletions docs/versions/v2/Model/PersonPictureResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # PersonPictureResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **bool** | If the response is successful or not | [optional]
**data** | [**\Pipedrive\versions\v2\Model\PersonPictureItem**](PersonPictureItem.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1 change: 0 additions & 1 deletion docs/versions/v2/Model/PipelineItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Name | Type | Description | Notes
**id** | **int** | The ID of the pipeline | [optional]
**name** | **string** | The name of the pipeline | [optional]
**order_nr** | **int** | Defines the order of pipelines. The pipeline with the lowest &#x60;order_nr&#x60; is considered the default. | [optional]
**is_selected** | **bool** | Whether this pipeline is selected or not | [optional]
**is_deleted** | **bool** | Whether this pipeline is marked as deleted or not | [optional]
**is_deal_probability_enabled** | **bool** | Whether deal probability is disabled or enabled for this pipeline | [optional]
**add_time** | **string** | The pipeline creation time | [optional]
Expand Down
4 changes: 4 additions & 0 deletions docs/versions/v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,7 @@ Class | Method | HTTP request | Description
*PersonsApi* | [**getPerson**](Api/PersonsApi.md#getperson) | **GET** /persons/{id} | Get details of a person
*PersonsApi* | [**getPersonFollowers**](Api/PersonsApi.md#getpersonfollowers) | **GET** /persons/{id}/followers | List followers of a person
*PersonsApi* | [**getPersonFollowersChangelog**](Api/PersonsApi.md#getpersonfollowerschangelog) | **GET** /persons/{id}/followers/changelog | List followers changelog of a person
*PersonsApi* | [**getPersonPicture**](Api/PersonsApi.md#getpersonpicture) | **GET** /persons/{id}/picture | Get picture of a person
*PersonsApi* | [**getPersons**](Api/PersonsApi.md#getpersons) | **GET** /persons | Get all persons
*PersonsApi* | [**searchPersons**](Api/PersonsApi.md#searchpersons) | **GET** /persons/search | Search persons
*PersonsApi* | [**updatePerson**](Api/PersonsApi.md#updateperson) | **PATCH** /persons/{id} | Update a person
Expand Down Expand Up @@ -574,6 +575,9 @@ Class | Method | HTTP request | Description
- [PersonItemIm](Model/PersonItemIm.md)
- [PersonItemPhones](Model/PersonItemPhones.md)
- [PersonItemPostalAddress](Model/PersonItemPostalAddress.md)
- [PersonPictureItem](Model/PersonPictureItem.md)
- [PersonPictureItemPictures](Model/PersonPictureItemPictures.md)
- [PersonPictureResponse](Model/PersonPictureResponse.md)
- [PersonRequestBody](Model/PersonRequestBody.md)
- [PersonRequestBodyEmails](Model/PersonRequestBodyEmails.md)
- [PersonRequestBodyPhones](Model/PersonRequestBodyPhones.md)
Expand Down
Loading