CurrenciesApi.md

Pipedrive\CurrenciesApi

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

Method	HTTP request	Description
getCurrencies()	GET /currencies	Get all supported currencies

getCurrencies()

getCurrencies($term): \Pipedrive\Model\Currencies

Get all supported currencies

Returns all supported currencies in given account which should be used when saving monetary values with other objects. The code parameter of the returning objects is the currency code according to ISO 4217 for all non-custom currencies.

Example

<?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\CurrenciesApi(
    // 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
);
$term = 'term_example'; // string | Optional search term that is searched for from currency's name and/or code

try {
    $result = $apiInstance->getCurrencies($term);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CurrenciesApi->getCurrencies: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
term	string	Optional search term that is searched for from currency's name and/or code	[optional]

Return type

\Pipedrive\Model\Currencies

Authorization

api_key, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]