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

hotjar User Lookup API

Endpoints for looking up user data and submitting deletion requests for GDPR compliance.

hotjar User Lookup API is one of 7 APIs that hotjar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.hotjar.io/v1.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.hotjar.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

hotjar User Lookup API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token obtained from the OAuth token endpoint using client credentials grant.

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.

User Lookup 1

Endpoints for looking up user data and submitting deletion requests for GDPR compliance.

POST
/organizations/{organization_id}/user-lookup
Look up or delete user data
userLookup 1 param body → 200401403404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are UserLookupRequest (3 properties), Error (2 properties), UserLookupResponse (2 properties). Each schema is shown below with its type and property counts.

UserLookupResponse
object
The result of a user lookup or deletion request.
2 properties
Error
object
An error response returned by the API when a request fails.
2 properties
UserLookupRequest
object
A request to look up or delete user data across sites in an organization. At least one of datasubjectemail or datasubjectsiteidtouseridmap must be provided.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hotjar-user-lookup-api-openapi.yml Raw ↑

Other APIs hotjar publishes across the network.

Hotjar Events API
Hotjar Identify API
Hotjar JavaScript SDK
hotjar Authentication API
hotjar Survey Responses API
hotjar Surveys API