For a given portal, return the list of keywords in JSON or XML format.
| Required Parameters | How to use | Description |
|---|---|---|
| HubSpot OAuth Access Token | access_token=X - Used in the request URL | The HubSpot API key for the portal that you're making the call for. |
| Optional Parameters | How to use | Description |
|---|---|---|
| None | None | No optional parameters for this method. |
Example URL requesting JSON: https://api.hubapi.com/keywords/v1/keywords.json?access_token=demooooo-oooo-oooo-oooo-oooooooooooo
Example JSON output. Please note that if a keyword has traffic attributed to it, we'll append some other fields to it based on the visits and lead data associated with that keyword. This sample output is displaying 2 keywords from the HubSpot demo portal, one with visits and leads, one without:
{
"keywords": [
{
"keyword": "hapipy_test_keyword519",
"keyword_guid": "2f2318ab-415c-41fd-acdb-9d401cb4adcc",
"created_at": 1322763500103
},
{
"keyword": "app",
"visits": 18,
"keyword_guid": "00e8568a-ca6a-4743-90a4-9dfb9b308a31",
"leads": 9,
"created_at": 1326410035595
}
]
}
Example URL requesting XML: https://api.hubapi.com/keywords/v1/keywords.xml?access_token=demooooo-oooo-oooo-oooo-oooooooooooo
Example XML output. Please note that if a keyword has traffic attributed to it, we'll append some other fields to it based on the visits and lead data associated with that keyword. This sample output is displaying 2 keywords from the HubSpot demo portal, one with visits and leads, one without:
<List>
<keywords>
<keyword>app</keywordkeyword>
<visits>18</visits>
<keyword_guid>00e8568a-ca6a-4743-90a4-9dfb9b308a31</keyword_guid>
<leads>9</leads>
<created_at>1326410035595</created_at>
</keywords>
<keywords>
<keyword>hapipy_test_keyword695</keyword>
<keyword_guid>da4dbde7-2ab3-40c7-8ad7-5c163105a7fd</keyword_guid>
</keywords>
</List>
HTTP Methods:
GET
Response Format:
json, xml
Requires Authentication?
Yes
Rate Limited?
Headers