API V2#

This guide is for developers integrating with OpenSPP.

NEW V2 - Complete redesign of the OpenSPP API

The official OpenSPP REST API (V2) provides a modern, secure, and standards-compliant interface for integrating with OpenSPP. This API replaces the legacy XML-RPC API and follows REST best practices, OAuth 2.0 authentication, and consent-based access control.

Topics Covered#

Topic

Description

API V2 Overview

API design philosophy and core concepts

Authentication

Secure authentication using OAuth 2.0

External Identifiers

Using external IDs instead of database IDs

Consent Management

Privacy-first consent mechanisms

API Resources

Available API resources and operations

Search and Filtering

Advanced query and filtering

Batch Operations

Processing multiple records efficiently

Error Handling

Error responses and status codes

Studio API Integration

Studio custom fields and variables via API

Note

This completely replaces the legacy XML-RPC API. New integrations should use API V2.