Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Koala Deletion API

GDPR right-to-erasure requests and status.

Koala Deletion API is one of 5 APIs that Koala publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deletion. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api2.getkoala.com, https://app.getkoala.com.

2 operations 2 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api2.getkoala.com/web/projects/{public_api_key}
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Koala Deletion API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (sk_) (SecretApiKey).

  • SecretApiKey — Secret API key created in Settings - API Keys, sent as Authorization: Bearer sk.... Used only by the Deletion (GDPR) API.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Deletion 2

GDPR right-to-erasure requests and status.

POST
/api/v1/deletion-requests
Request GDPR deletion for a set of emails
createDeletionRequest body → 200401
GET
/api/v1/deletion-requests/{deletionRequestId}
Check GDPR deletion status
getDeletionRequest 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DeletionRequestStatus (8 properties), DeletionRequest (1 property), DeletionRequestCreated (1 property). Each schema is shown below with its type and property counts.

DeletionRequestCreated
object
1 property
DeletionRequestStatus
object
8 properties
DeletionRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koala-io-deletion-api-openapi.yml Raw ↑

Other APIs Koala publishes across the network.

Koala Web Pixel (JavaScript SDK)
Koala Accounts API
Koala Collection API
Koala SDK API