Our Commitment to Supporting API Integrations
We’re here to support all ScaleGrowth customers who are building custom integrations or apps using our API. Whether you're working with internal developers or third-party tools like Postman, Bubble, or Make.com, we want to help ensure your integration is successful.
That said, debugging application logic or third-party configuration (e.g. how Postman or Bubble handle auth) is outside the scope of what our support team can assist with directly.
To streamline support and maximize clarity, the best way to get help is to reproduce the issue using curl – the industry standard for isolating API-level behavior. This ensures we're seeing the cleanest, lowest-level interaction between your application and our API.
How to Submit an API Issue
When submitting an API support request or reporting a potential bug, please:
0. Enable timestamps – with milliseconds & timezone – in your terminal (one-time setup)
Here is an example of how to do this with .zshrc on a Mac with homebrew :
- first, in your terminal, run:
brew install coreutils - then, do
nano ~/.zshrc - add these lines to your
~/.zshrc:
autoload -U colors && colors
setopt prompt_subst
PROMPT='%{$fg[yellow]%}[$(gdate "+%d/%m/%y %H:%M:%S.%3N %Z")] %n@%h%{$reset_color%} '
- and make sure to save your
~/.zshrc - finally, restart your terminal
- – you should now see something like this:
For other environments, ask ChatGPT or your favorite AI :-)
1. Reproduce the issue using curl – https://curl.se/
- This eliminates dependencies from third-party tools or platform behavior
2. Share full screenshots of your terminal with the following:
- The full curl request
- The full API response
- Any relevant HTTP status codes
- Timestamps enabled
3. Make sure to include:
- The full URL and query parameters
- All headers (e.g. Authorization, Content-Type, etc.)
- The body payload (for POST, PUT, or PATCH requests)
Note: If you're using an API key, it’s safe (and helpful) to include the client_id. You may redact the client_secret if needed. As a best practice, rotate your API key after any support exchange by creating a new client with the same configuration.
Example: Debugging a Member List API Call
Let's say you are troubleshooting an issue with listing members on your platform using the client_credentials OAuth flow.
Step 1: Fetch the Bearer Token
curl -X POST "https://yourdomain.com/o/token/" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=YOUR_CLIENT_ID" \
-d "client_secret=REDACTED"
Response:
{ "access_token": "abc123...", "token_type": "Bearer", "expires_in": 3600 }
Step 2: Retrieve Members List
curl -X GET "https://yourdomain.com/api/v1/members/" \
-H "Authorization: Bearer abc123..."
Response:
{ "count": 42, "results": [...] }
Make sure these commands and their responses are captured in full in your support request. If there are any errors or HTML responses, include those with exact timestamps.
Debugging & Reporting with Asynchronous APIs
If you are using our ScaleGrowth Asynchronous API, please still follow the above guidelines for the curl API calls and responses. In addition to that, please share with us the original POST headers & body for the request your Callback endpoint receives from our server, if any.
It is important that you share these before any processing on your end, as debugging application logic or third-party configuration is outside the scope of what our support team can assist with directly.
Enterprise and Professional Services Support
For Enterprise customers, our team is able to directly partner with your technical team to help debug and implement integrations with third-party tools or your own custom applications.
If you're not currently on an Enterprise plan but would like this level of support, our Professional Services team is also available to assist on a paid engagement basis. Please reach out through your Success Center if you're interested in Professional Services support – or contact your account manager if you're an Enterprise customer.
Summary
We’re committed to supporting your success with the ScaleGrowth API, and the fastest way for us to help is when you provide clear, isolated, and reproducible curl requests with full context. This allows us to diagnose any true API issues quickly and keep support focused on what we can best resolve. While we can’t troubleshoot custom application logic or third-party tools directly, we’re always happy to assist with confirmed API-level behavior and guide you forward.
For advanced integration help, Enterprise customers may engage directly with our technical team, and Professional Services are available upon request for all other customers.
