Overview
Customer Success teams and technical admins often need to get Hook data into other systems, or query Hook programmatically for reporting, automation, and integrations that go beyond what's available natively. Doing this without an API means manual exports, local filtering of thousands of records, and unreliable workarounds.
The Hook Public API provides programmatic read access to your Hook data. It is authenticated using API tokens and scoped to your organisation.
Full documentation can be found at docs.api.hook.co.
What the API currently covers
The following endpoints are available from the API:
Members: Access member profiles and role assignments
Customers: List and query customer records
Products: Access product data
Signals: Read risk and engagement signals, including the ability to set a primary risk signal on creation
Notes: Notes added on account pages
When to use the API
There are several use cases for accessing Hook data using the API, including:
Pulling Hook data into an external dashboard or reporting tool
Running scheduled exports of customer, signal, or notes data in CSV or JSON format
Powering custom integrations that aren't covered by Hook's native connectors
Add notes created using Hook to your CRM using the notes endpoint
đĄ Hook's public API is currently read-only.
Getting Started with the Hook API
Step 1: Generate an API Token
API tokens are generated through the Hook UI. Tokens are scoped to your organisation, ensuring strict data isolation, and include rate limiting and expiry controls.
Go to Profile settings > API Tokens in Hook
Click + Create Token
Give the token a name and set the time period the API token should be valid for (default value is 30 days). Note: the token will expire after this time period, and any future API requests will not be valid.
Click Create token
Copy your API token (it will not appear after exiting this screen)
Creating a new API token in Profile settings
Step 2: Make your First Request
Use the token copied in Step 1 to authenticate requests against the Hook API endpoints.
Full documentation can be found at docs.api.hook.co.
âFrequently asked questions
Who can use the Hook API?
Anyone with a Hook account can generate a API token.
Are there limits to the data I can access?
Each token is scoped to the permissions of the user who created it. API requests made with a token cannot exceed the access level of that user. For example, if your permissions are Can view: My customers, then the API will only return data for customers you're assigned to. Find out more about permissions here.
Can I generate multiple API tokens for different applications?
Create more than one API token by clicking + Create token in Profile settings > API Tokens, naming each one appropriately.
What is the maximum token lifetime for API tokens?
365 days. Token lifetime can be configured when creating an API token.
What is the rate limit and quota limit?
The rate limit is 100 requests per second. Requests exceeding this rate will receive a 429 Too Many Requests response.
The quota limit is 100,000 requests per day. The quota resets every 24 hours. Once exhausted, further requests will receive a 429 Too Many Requests response until the quota renews.