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

Hopae, Inc. Workspace API - Activation API

Provider activation per app

Hopae, Inc. Workspace API - Activation API is one of 9 APIs that Hopae, Inc. publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspace API - Activation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://sandbox.api.hopae.com/connect.

5 operations 5 paths 2 schemas 1 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://sandbox.api.hopae.com/connect
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 5

Hopae, Inc. Workspace API - Activation API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (API Key) (workspaceApiKey). It accepts HTTP bearer tokens (JWT) (consoleJwt). It accepts HTTP bearer tokens (JWT) (workspace-api-key). It accepts HTTP basic authentication (app-basic).

  • basicAuth — Basic authentication using clientId and clientSecret. For direct API calls, format the Authorization header as Authorization: Basic . In the Mintlify playgroun…
  • workspaceApiKey — Workspace API key authentication. Pass your workspace API key as Authorization: Bearer skworkspace....
  • consoleJwt — Console JWT authentication. Issued by Clerk after Console login.

Paths & Operations 5

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

Workspace API - Activation 5

Provider activation per app

GET
/v1/apps/{id}/providers/{providerId}/activation/steps
Get activation steps
WorkspaceActivationController_getActivationSteps 2 params → 200401404
PATCH
/v1/apps/{id}/providers/{providerId}/activation
Enable or disable provider
WorkspaceActivationController_enableProvider 2 params body → 200401404
POST
/v1/apps/{id}/providers/{providerId}/activation/form
Submit activation form
WorkspaceActivationController_submitActivationForm 2 params body → 201401404
POST
/v1/apps/{id}/providers/{providerId}/activation/documents
Upload activation documents
WorkspaceActivationController_uploadDocuments 2 params → 201401404
DELETE
/v1/apps/{id}/providers/{providerId}/activation/documents/{documentId}
Delete an activation document
WorkspaceActivationController_deleteDocument 3 params → 200401404409

Schemas 2

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

WorkspaceSubmitActivationFormDto
object
2 properties 1 required
WorkspaceEnableProviderBodyDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hopae-inc-workspace-api-activation-api-openapi.yml Raw ↑

Other APIs Hopae, Inc. publishes across the network.

Hopae, Inc. Console - API Keys API
Hopae, Inc. Providers API
Hopae, Inc. Token API
Hopae, Inc. Verifications API
Hopae, Inc. Workspace API - Apps API
Hopae, Inc. Workspace API - Production Tests API
Hopae, Inc. Workspace API - Workflows API
Hopae, Inc. Workspace API - Workspace API