topic Re: Trying my first API call from VS Code in APIs & Integrations

Trying my first API call from VS Code

SMCNULTY — Fri, 17 Mar 2023 18:29:44 GMT

Hello,

I'm just starting out trying to make my first API call to HS. I'm a complete NOOB. I think what I'm doing might be getting phased out but I wanted to start here and work my way up. I am using VS Code and have a handful of extensions installed. (REST Client / Thunder ) I have node.JS installed. Outside of Hubspot, I've been able to successfully run a "GET" call to a test website and it returned JSON data.

I'm now looking at some archived instructions per the snippet below. I've created a private app (access to literally all options) and have my token ready.

I've tried pasting the node.JS code (below) into VScode and also tried a GET command on the example http address shown in the snippet (with my token pasted in) but neither is working.

I tried this with my own email address (which is a contact in HS) and I'm getting a message that the Hapikey does not exist.

UPDATE:

I bounced completely over to POSTMAN and ran a GET as shown below:

1.) My private app token is stored as a secret Global variable

2.) Parameters Key Properties value is email

3.) Authorization is 'Bearer Token'

and getting the error shown below.

Re: Trying my first API call from VS Code

Jaycee_Lewis — Fri, 17 Mar 2023 21:51:24 GMT

Hi, @SMCNULTY 👋 I think I can help out here.

Let's start with this endpoint — Get a contact by email address. Looking at your screenshot, it looks like you are trying to include your bearer token in the request URL. This won't work. Private Apps, and OAuth, require you to send the Authorization in the header. Meaning, instead of including it in the URL like the example:

https://api.hubapi.com/contacts/v1/contact/email/testingapis@hubspot.com/profile?hapikey=demo

you'll need to include it in your header — bearer token in the Authorization HTTP header. So, an example using Node might look like this example Postman provided:

For your second question, we can also use Postman to help us out. What tricky about this one is getting the request URL set up correctly, so you can search by email address instead of ID.

It seems like the way you're trying to include the bearer token in Postman is different from how I do it. I'll add screenshots of what my set-up looks like below.

Here's an example:

Request:
GET https://api.hubapi.com/crm/v3/objects/contacts/tina%40bobsburgers.com?archived=false&idProperty=email
Response:
{ "id": "1001", "properties": { "createdate": "2022-11-03T21:42:31.255Z", "email": "tina@bobsburgers.com", "firstname": "Tina", "hs_object_id": "1001", "lastmodifieddate": "2023-02-01T17:33:35.259Z", "lastname": "Belcher" }, "createdAt": "2022-11-03T21:42:31.255Z", "updatedAt": "2023-02-01T17:33:35.259Z", "archived": false }

If this isn't quite what you are after, please let us know, and we will get you pointed in the right direction.

Best,

Jaycee

Re: Trying my first API call from VS Code

SMCNULTY — Fri, 17 Mar 2023 22:02:38 GMT

Jaycee,

Thank you very much for the response. I've actually had great luck today in Postman. (after weeks of struggling) I'm going to hold off on VS Code for a while and just get everything working that I want to use in PM. I'm now able to use PM and successfully used Gets for contact info/ all owners / and to get ticket details. See image below. Currently stuck on creating a ticket though so if you have a comment on this "The request body may not be null" that's where I'm at.

In this case "hubspot_owner_ID" 104607097 should be me.

Re: Trying my first API call from VS Code

Jaycee_Lewis — Fri, 17 Mar 2023 22:41:21 GMT

Hey hey, @SMCNULTY! Let's take a look at my request, and maybe you can spot what's different on your end. Additionally, can you grab a screenshot of how your request body is set in Postman, please?

In the body tab, I set mine to “raw” and “JSON”. Like this:

Here's my request URL, JSON body, and the response using the Tickets API and an example request body from the page — CRM API | Tickets.

POST {{API URL}}/crm/v3/objects/tickets

{ "properties": { "hs_pipeline": "19625033", "hs_pipeline_stage": "47925262", "hs_ticket_priority": "HIGH", "subject": "Cats and ninjas", "hubspot_owner_id": "198670650" }, "associations": [ { "to": { "id": 901 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 16 } ] } ] }

{ "id": "1503346867", "properties": { "createdate": "2023-03-17T22:27:14.029Z", "hs_all_accessible_team_ids": "12073943", "hs_all_owner_ids": "198670650", "hs_all_team_ids": "12073943", "hs_helpdesk_sort_timestamp": "2023-03-17T22:27:14.029Z", "hs_lastmodifieddate": "2023-03-17T22:27:14.029Z", "hs_object_id": "1503346867", "hs_pipeline": "19625033", "hs_pipeline_stage": "47925262", "hs_ticket_id": "1503346867", "hs_ticket_priority": "HIGH", "hs_user_ids_of_all_owners": "10233975", "hubspot_owner_assigneddate": "2023-03-17T22:27:14.029Z", "hubspot_owner_id": "198670650", "hubspot_team_id": "12073943", "subject": "Cats and ninjas" }, "createdAt": "2023-03-17T22:27:14.029Z", "updatedAt": "2023-03-17T22:27:14.029Z", "archived": false }

Best,

Jaycee

Re: Trying my first API call from VS Code

SMCNULTY — Mon, 20 Mar 2023 15:12:54 GMT

Interestingly enough I have nothing (well a '1') in my POST Body. I checked my "working" GET body's and those also all show '1'. The Get's work but the Post does not.

I'm not sure why nothing is showing up in the Body>raw>JSON field.

>>EDIT>> I put the JSON code into the RAW>BODY of my create ticket POST and I was able to create a ticket. That's good. Just not sure why when I put the fields in under parameters tab it didn't do the same thing. This may be more of a Postman forum question than HS so ok to close this out if needed.

This is my attempt at a POST and it does not work

This is a GET which works fine: