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 Accounts API

Account-level (company) trait and event ingestion.

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

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

This API exposes 1 operation across 1 path, and defines 4 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.

1 operations 1 paths 4 schemas 1 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 Accounts 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 1

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

Accounts 1

Account-level (company) trait and event ingestion.

POST
/web/projects/{publicApiKey}/accounts/batch
Ingest account (company) traits and events
collectAccountBatch 2 params body → 200400

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are TrackEvent (5 properties), AccountBatchRequest (5 properties), IdentifyCall (3 properties). Each schema is shown below with its type and property counts.

AccountBatchRequest
object
An account-scoped batch. At least one of domain or accountid is required; domain is recommended.
5 properties
CollectionAck
object
Acknowledgement that the batch was accepted.
IdentifyCall
object
3 properties 1 required
TrackEvent
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Koala publishes across the network.

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