Skip to content

Documented get_by_id #427

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

Open
rikkiprince wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Documented get_by_id #427

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,20 @@ You'll need to create a [private app](https://developers.hubspot.com/docs/api/pr

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

### Get one

`get_by_id` method is available for all objects.

```ruby
client = Hubspot::Client.new(access_token: 'your_oauth2_access_token')
user = client.crm.owners.owners_api.get_by_id(owner_id: <user_id>])
```

Tip: If you are unsure what property name to pass in, call the method with no parameters and the name at the end of the error message will tell you:

`#<LoadError: cannot load such file -- hubspot/codegen/crm/owners/models/owner_id>` => **owner_id**


## Search

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