API Access Setup

How API access is provisioned and granted to a customer instance.

Base URL

https://scalinguptoolkit.com/api/v1

(Per-instance: the base URL is the customer's instance domain + /api/v1.)

Provisioning steps

The create-API-client wizard has 4 steps: 1) Client details → 2) API scopes → 3) Check-out → 4) Credentials.

1. Client details:
   • App name (unique), Website URL (domain the client calls from), optional Description.
   • Auth-type: OAuth2 (recommended), API Key, or Basic. ⚠️ API Key and Basic are read-only; pick OAuth2 for any write interaction.
   • Callback URL: the URL the access token information is sent to. For OAuth2, the customer gives you their return URL and you set it here.
   • Connected User: the API client uses this user's access shares (i.e. it inherits that user's data access).
2. API scopes: select the end-points the app may use ("Please select the API end-points your app is going to use").
3. Check-out, then Credentials: issues the client ID and client secret. Share them with the customer out-of-band.

⚠️ Warning: Changing essential details of an existing API client will regenerate the client-secret.

⚠️ Scope must match at authorization: the scopes requested when authenticating must match what's enabled on the client. Access is always limited to the opened end-points. See Authentication.

Granting access (scopes)

Access is controlled per end-point via the Scopes tab. For example, for the Growth Institute client, 22 scopes are enabled, covering the full /members and /groups end-point families. /campaigns end-points exist but are not enabled for that client.

• /groups — managing the folders in the Members-tree.
• /members — managing the individual members.

See Endpoints for the full list.