API Overview

Beta: The REST API is currently in beta. The resources and endpoints documented here are stable, but additional resources, data APIs, and SDK generation are actively being built. Expect more capabilities soon.

The Ours Privacy REST API gives you programmatic access to manage your account configuration. Use it to automate setup, integrate with CI/CD pipelines, build custom tooling, or manage accounts at scale.

The API is available at app.oursprivacy.com/rest/v1/ and follows standard REST conventions. All requests are authenticated with organization API keys.

---

Why Use the API?

• Automate account configuration — script bulk operations instead of clicking through the UI
• CI/CD integration — manage tag, destination, and consent configurations as code
• Custom tooling — build internal tools and dashboards on top of your Ours Privacy data
• Multi-account management — configure multiple accounts programmatically

---

Resources

Browse the section nav for the full list of resources, or fetch the OpenAPI spec at GET /rest/v1/openapi.json for a machine-readable catalog.

---

SDKs

If you'd rather not call the REST API directly, see SDKs and MCP — wrappers for Node.js / TypeScript, Go, the command line, and an MCP server for AI assistants. All are generated from the same OpenAPI spec.

---

Key Concepts

• Base URL: https://app.oursprivacy.com/rest/v1/
• Authentication: Bearer token using organization API keys (see Authentication)
• Response format: All responses return { "data": ... }
• OpenAPI spec: Available at GET /rest/v1/openapi.json (no authentication required)
• Error handling: Standard HTTP status codes (400, 401, 403, 404, 405, 500)

PATCH Semantics

Across this API, PATCH means partial update:

• Omitted fields stay unchanged
• Send null to clear a nullable field
• Resource pages only call out PATCH behavior when they need to explain a resource-specific exception or nested write shape

---

Getting Started

1. Set up authentication: Create an API key in your organization settings
2. Make your first request: List your destinations with a single curl command

---

Need Help?

If you have questions about the API or need assistance, reach out to support@oursprivacy.com.