GoldLeaf API Docs

Getting Started

Welcome to the GoldLeaf API documentation. This guide will help you get started with using the GoldLeaf API, including obtaining API keys, making requests, and handling security tokens.

Prerequisites

• A Professional or Enterprise subscription to access the GoldLeaf API.
• An API Key created in GoldLeaf on the API tab: https://goldleaf.app/organization/integrations

On the Add New API Key dialog, a name is required. Then Add all trusted IP addresses that should be allowed to generate a security token with this API key. You may add an expiry date or leave blank for no expiry. The API key will be generated up successfully saving.

Warning The trusted IP addresses for an API key will only allow security tokens to be created from that API key on those specific IP addresses. However, once a security token has been created it will allow access to GoldLeaf from any IP. Security Tokens expire after one hour and need to be refreshed manually.