Reach endpoints and troubleshooting

Find the right resource, scope, and diagnostic view.

Open this guide in the help center →

When to use this. You are connecting a sales process and need to know which API family owns each operation.

What you’ll need. A Reach API key with the relevant scopes and access to the workspace’s API Access page.

  1. Use the Reach base path

    The verified installation uses https://reach.formbot.com/api/v1. Append the /reach paths shown below. These are Reach endpoints, separate from platform.formbot.com API documentation.

  2. Match the scope to the action

    The signed-in API Access page lists resource-specific scopes. Use read scopes for reads and the specific write or delete scope for a mutation.

  3. Inspect failed requests

    Check HTTP status, error code, message, and request ID when present. The public page documents an error object, while API Access describes errors[]. Write defensive handling for the actual response rather than hard-coding an unverified envelope.

  4. Page through results and check logs

    Use page and limit for list APIs. Review Recent API usage for endpoint, status, and response time, and review webhook delivery logs for callback failures.

How to know it worked

You can select the correct endpoint family and diagnose an authorization or request failure.

Features covered

Continue learning