Get the portal context for the bearer token
curl --request GET \
--url https://app.hookie.ai/portal/api/me \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.hookie.ai/portal/api/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/portal/api/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"portal": {
"name": "Acme Webhooks",
"branding": {
"color": "#8B5CF6"
}
},
"customer_id": "cus_9182",
"event_types": [
"orders",
"invoices"
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Customer Portal
Get the portal context for the bearer token
GET
/
portal
/
api
/
me
Get the portal context for the bearer token
curl --request GET \
--url https://app.hookie.ai/portal/api/me \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.hookie.ai/portal/api/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/portal/api/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"portal": {
"name": "Acme Webhooks",
"branding": {
"color": "#8B5CF6"
}
},
"customer_id": "cus_9182",
"event_types": [
"orders",
"invoices"
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
portalTokenHeaderportalTokenQuery
A hpt_… customer portal token, as Authorization: Bearer. Stored hashed; shown once at issue.
Query Parameters
Portal access token (hpt_…), as an alternative to the Authorization: Bearer header. The header is checked first; the query parameter is used only when no Bearer header is present.
Response
Portal identity and the datasets it exposes.
Show child attributes
Show child attributes
The workspace's own identifier for this end customer, taken from the token (portal_tokens.customer_id). Not settable by the customer.
Dataset names this portal exposes; [] if the stored value is unparseable. An empty array means no dataset restriction is applied to new destinations.