Skip to main content
This section covers the developer-facing capabilities of Pals Club. API availability depends on the product roadmap — check back regularly or contact support to request access.
This section will be expanded as developer resources become available. The information below serves as a structural preview of what to expect.

​
API overview

The Pals Club API provides programmatic access to core platform features. The API follows REST conventions and returns JSON responses.
API endpoints described here are placeholders. Confirm availability and current specifications with the Pals Club team before building integrations.
Base URL (placeholder)
https://api.palsclub.com/v1
Key characteristics:
  • Protocol: HTTPS only
  • Format: JSON request and response bodies
  • Versioning: URL-based (e.g., /v1/)
  • Documentation: OpenAPI specification will be published at [API_DOCS_URL]

​
Authentication

All API requests require authentication. Pals Club supports the following methods:
Include your API key in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.palsclub.com/v1/me
API keys can be generated from the Developer settings page in your Pals Club dashboard. Each key is scoped to a specific set of permissions.
Never expose API keys or access tokens in client-side code or public repositories. Store credentials securely using environment variables or a secrets manager.

​
Rate limits

To protect platform stability, the API enforces rate limits on all endpoints.
TierRequests per minuteBurst limit
Free6010
Pro30050
EnterpriseCustomCustom
When you exceed the rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait before retrying.
Implement exponential backoff in your integration to handle rate-limit responses gracefully.

​
Webhooks

Webhooks allow your application to receive real-time notifications when events occur in Pals Club.
1

Register a webhook endpoint

Provide a publicly accessible HTTPS URL in the Developer settings page of your dashboard. Select the event types you want to subscribe to.
2

Verify webhook signatures

Each webhook request includes an X-PalsClub-Signature header. Verify this signature using your webhook secret to confirm the request is authentic.
3

Process events

Parse the JSON payload and handle the event type. Respond with a 200 status code within 10 seconds to acknowledge receipt.
4

Handle retries

If your endpoint does not respond with a 2xx status code, Pals Club retries the delivery up to [MAX_RETRIES] times with exponential backoff.
Example event types (placeholder):
  • user.created
  • user.updated
  • connection.accepted
  • payment.completed
  • subscription.changed

​
SDKs and libraries

Official SDKs simplify integration by handling authentication, serialization, and error handling.
LanguagePackageStatus
JavaScript / TypeScript@palsclub/sdk[PLACEHOLDER]
Pythonpalsclub-python[PLACEHOLDER]
Rubypalsclub-ruby[PLACEHOLDER]
Gopalsclub-go[PLACEHOLDER]
SDK availability is subject to change. Check the official repositories or contact the Pals Club team for the latest status.

Contact support

Questions about API access or integrations

FAQ

Frequently asked questions

Features overview

Platform capabilities and feature details