Skip to content

Readme: Update, Clean up #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alzheltkovskiy-hubspot merged 1 commit into from
Sep 9, 2025
Merged

Readme: Update, Clean up #450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 16 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,8 @@ pip install --upgrade hubspot-api-client

Make sure you have [Python 3.7+](https://docs.python.org/3/) and [pip](https://pypi.org/project/pip/) installed.


## Quickstart


### Configuring HubSpot client

```python
Expand All @@ -36,15 +34,15 @@ api_client = HubSpot()
api_client.access_token = 'your_access_token'
```

You'll need to create a [private app](https://developers.hubspot.com/docs/api/private-apps) to get your access token or you can obtain OAuth2 access token.
You'll need to create a [private app](https://developers.hubspot.com/docs/apps/legacy-apps/private-apps) to get your access token or you can obtain OAuth2 access token.

#### Hapikey support:
#### Hapikey support

Please, note that hapikey is no longer supported after v5.1.0. You can get more info about hapikey sunset [here](https://developers.hubspot.com/changelog/upcoming-api-key-sunset). Also, plese, visit a [migration guide](https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app) if you need help with a migration process.

### OAuth API

#### Obtain OAuth2 access token:
#### Obtain OAuth2 access token

```python
from hubspot.oauth import ApiException
Expand All @@ -63,8 +61,7 @@ except ApiException as e:

### CRM API


#### Create contact:
#### Create contact

```python
from hubspot.crm.contacts import SimplePublicObjectInputForCreate
Expand All @@ -81,7 +78,7 @@ except ApiException as e:
print("Exception when creating contact: %s\n" % e)
```

#### Get contact by id:
#### Get contact by id

```python
from hubspot.crm.contacts import ApiException
Expand All @@ -92,7 +89,7 @@ except ApiException as e:
print("Exception when requesting contact by id: %s\n" % e)
```

#### Get custom objects page:
#### Get custom objects page

```python
from hubspot.crm.objects import ApiException
Expand All @@ -103,7 +100,7 @@ except ApiException as e:
print("Exception when requesting custom objects: %s\n" % e)
```

#### Get all:
#### Get all

`get_all` method is available for all objects (Companies, Contacts, Deals and etc).

Expand All @@ -113,11 +110,12 @@ all_contacts = api_client.crm.contacts.get_all()

Please note that pagination is used under the hood to get all results.

## Search:
## Search

`do_search` method is available for all objects (Companies, Contacts, Deals and etc).

### Example Search by date:
### Example Search by date

```python
import hubspot

Expand Down Expand Up @@ -152,7 +150,7 @@ except ApiException as e:

### CMS API

#### Get audit logs:
#### Get audit logs

```python
from hubspot.cms.audit_logs import ApiException
Expand All @@ -165,7 +163,8 @@ except ApiException as e:

### Files API

#### Upload files:
#### Upload files

```python
import hubspot
import json
Expand Down Expand Up @@ -252,9 +251,10 @@ try:
except ApiException as e:
print(e)
```

### Using utils

#### Get OAuth url:
#### Get OAuth url

```python
from hubspot.utils.oauth import get_auth_url
Expand Down Expand Up @@ -301,6 +301,7 @@ retry = Retry(
)
api_client = HubSpot(retry=retry)
```

Or with rate limit retry middleware:

```python
Expand Down