hubspot-api-php

PHP HubSpot API v3 SDK(Client) files

Installation

composer require hubspot/api-client

Requirements

The current package requirements are:

PHP >= 8.1

Sample apps

Please, take a look at our Sample apps

Quickstart

To instantiate API Client using access token use Factory

$hubspot = \HubSpot\Factory::createWithAccessToken('your-access-token');

You'll need to create a private app to get your access token or you can obtain OAuth2 access token.

To instantiate API Client using developer apikey use Factory

$hubspot = \HubSpot\Factory::createWithDeveloperApiKey('your-developer-apikey');

also you can pass custom client to Factory

$client = new \GuzzleHttp\Client([...]);

$hubspot = \HubSpot\Factory::createWithAccessToken('your-access-token', $client);

To change the base path

$config = new \GuzzleHttp\Client();
$config->setBasePath('*');
$config->setAccessToken('*');
$config->setDeveloperApiKey('*');

$hubspot = \HubSpot\Factory::create(null, $config);

Retry Middleware

The API client provides retry middleware for three failure scenarios: rate limiting (429), internal server errors (500–503, 520–599), and connection errors. All middleware retry up to RetryMiddlewareFactory::DEFAULT_MAX_RETRIES (5) times by default.

If no delay function is provided, Guzzle applies its built-in exponential backoff. Available delay helpers:

• Delay::getConstantDelayFunction(int $secondsDelay = 10) — fixed delay between retries
• Delay::getLinearDelayFunction() — delay grows linearly with retry count

Please note that Apps using OAuth are only subject to a limit of 100 requests every 10 seconds.

$handlerStack = \GuzzleHttp\HandlerStack::create();

// Retry on 429 with a constant 10-second delay
$handlerStack->push(
    \HubSpot\RetryMiddlewareFactory::createRateLimitMiddleware(
        \HubSpot\Delay::getConstantDelayFunction()
    )
);

// Retry on 5xx errors (exponential backoff by default)
$handlerStack->push(
    \HubSpot\RetryMiddlewareFactory::createInternalErrorsMiddleware()
);

// Retry on connection errors for cURL codes 52, 55, 56 (exponential backoff by default)
// Pass an empty array to retry all ConnectExceptions regardless of cURL error code
$handlerStack->push(
    \HubSpot\RetryMiddlewareFactory::createConnectionErrorsMiddleware()
);

$client = new \GuzzleHttp\Client(['handler' => $handlerStack]);

$hubspot = \HubSpot\Factory::createWithAccessToken('your-access-token', $client);

Get contacts page

$response = $hubspot->crm()->contacts()->basicApi()->getPage();

Get contact by email

$contact = $hubSpot->crm()->contacts()->basicApi()->getById('example@example.com', null, null, null, false, 'email');

Search for a contact

$filter = new \HubSpot\Client\Crm\Contacts\Model\Filter();
$filter
    ->setOperator('EQ')
    ->setPropertyName('email')
    ->setValue($search);

$filterGroup = new \HubSpot\Client\Crm\Contacts\Model\FilterGroup();
$filterGroup->setFilters([$filter]);

$searchRequest = new \HubSpot\Client\Crm\Contacts\Model\PublicObjectSearchRequest();
$searchRequest->setFilterGroups([$filterGroup]);

// Get specific properties
$searchRequest->setProperties(['firstname', 'lastname', 'date_of_birth', 'email']);

// @var CollectionResponseWithTotalSimplePublicObject $contactsPage
$contactsPage = $hubspot->crm()->contacts()->searchApi()->doSearch($searchRequest);

Create a contact

$contactInput = new \HubSpot\Client\Crm\Contacts\Model\SimplePublicObjectInput();
$contactInput->setProperties([
    'email' => 'example@example.com'
]);

$contact = $hubspot->crm()->contacts()->basicApi()->create($contactInput);

Update a contact

$newProperties = new \HubSpot\Client\Crm\Contacts\Model\SimplePublicObjectInput();
$newProperties->setProperties([
    'email' => 'updatedExample@example.com'
]);

$hubspot->crm()->contacts()->basicApi()->update($contactId, $newProperties);

Archive a contact

$hubspot->crm()->contacts()->basicApi()->archive($contactId);

Get custom objects page

$hubspot->crm()->objects()->basicApi()->getPage($objectType)

File uploading

$file = new \SplFileObject('file path');
$response = $hubspot->files()->filesApi()->upload($file, null, '/', null, null, json_encode([
    'access' => 'PRIVATE',
    'ttl' => 'P2W',
    'overwrite' => false,
    'duplicateValidationStrategy' => 'NONE',
    'duplicateValidationScope' => 'EXACT_FOLDER'
]) );

Not wrapped endpoint(s)

It is possible to access the hubspot request method directly, it could be handy if client doesn't have implementation for some endpoint yet. Exposed request method benefits by having all configured client params.

$response = $hubspot->apiRequest([
    'method' => 'PUT',
    'path' => '/some/api/not/wrapped/yet',
    'body' => ['key' => 'value'],
]);

apiRequest options

[
    'method' => string, // Http method (e.g.: GET, POST, etc). Default value GET
    'path' => string, // URL path (e.g.: '/crm/v3/objects/contacts'). Optional
    'headers' => array, // Http headers. Optional.
    'body' => mixed, // Request body (if defaultJson set body will be transforted to json string).Optional.
    'authType' => enum(none, accessToken, hapikey, developerApiKey), // Auth type. if it isn't set it will use accessToken or hapikey. Default value is non empty auth type.
    'baseUrl' => string, // Base URL. Default value 'https://api.hubapi.com'.
    'qs' => array, // Query parameters. Optional.
    'defaultJson' => bool, // Default Json. if it is set to true it add to headers [ 'Content-Type' => 'application/json', 'Accept' => 'application/json, */*;q=0.8',]
    // and transfort body to json string. Default value true
];

get contacts

$response = $hubspot->apiRequest([
    'path' => '/crm/v3/objects/contacts',
]);

Reserved words

The SDK has reserved words(e.g. clone). Full list of reserved words. When you face with a reserved word you have to add _ before the word(e.g. _clone).

Contributing

Run spec tests

vendor/bin/phpspec run

Run unit tests

vendor/bin/phpunit ./tests