Skip to content

Getting Started

Getting Started with SchoolPalm

Get up and running with SchoolPalm in minutes. This guide covers account setup, authentication, and your first API call.

Create a Developer Account

  1. Visit SchoolPalm Developer Console
  2. Sign up with your email or GitHub account
  3. Verify your email address
  4. Complete your developer profile

Generate API Keys

Once your account is created:

  1. Navigate to Settings → API Keys
  2. Click Generate New Key
  3. Name your key (e.g., “Development Key”)
  4. Copy and store it securely (you won’t see it again!)
  5. Add a webhook URL if needed

Security Note: Never commit API keys to version control. Use environment variables instead.

export SCHOOLPALM_API_KEY="your-api-key-here"

Choose Your SDK

SchoolPalm provides official SDKs for:

  • Node.js - npm install schoolpalm
  • Python - pip install schoolpalm
  • Go - go get github.com/schoolpalm/go-sdk
  • Java - Maven: com.schoolpalm:schoolpalm-client
  • Ruby - gem install schoolpalm

View all SDKs →

Make Your First API Call

Using the SDK (Node.js)

const SchoolPalm = require('schoolpalm');

const client = new SchoolPalm({
  apiKey: process.env.SCHOOLPALM_API_KEY
});

// Get your account info
const account = await client.account.get();
console.log(account);

Using cURL

curl -X GET https://api.schoolpalm.io/v1/account \
  -H "Authorization: Bearer $SCHOOLPALM_API_KEY"

Explore the API

Browse all available endpoints in the API Reference.

Next Steps

Common Issues

“Unauthorized” error? - Check that your API key is valid and has the correct permissions.

Rate limited? - Standard limits are 1000 requests/hour. Contact support for higher limits.

Need help? - Check the FAQ or GitHub Discussions.