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

App management

Hopae, Inc. Workspace API - Apps 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 - Apps. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 8 paths, and defines 15 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.

13 operations 8 paths 15 schemas 1 DELETE5 GET2 PATCH4 POST1 PUT

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 - Apps 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 13

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

Workspace API - Apps 13

App management

POST
/v1/apps
Create a new app
WorkspaceAppsController_createApp body → 201401
GET
/v1/apps
List all apps
WorkspaceAppsController_listApps 2 params → 200401
POST
/v1/apps/batch
Batch create apps
WorkspaceAppsController_batchCreateApps body → 201401
GET
/v1/apps/{id}/redirect-uris
Get redirect URIs
WorkspaceAppsController_getRedirectUris 1 param → 200401404
PUT
/v1/apps/{id}/redirect-uris
Update redirect URIs
WorkspaceAppsController_updateRedirectUris 1 param body → 200401404
GET
/v1/apps/{id}/webhook-config
Get webhook configuration
WorkspaceAppsController_getWebhookConfig 1 param → 200401404
PATCH
/v1/apps/{id}/webhook-config
Update webhook configuration
WorkspaceAppsController_updateWebhookConfig 1 param body → 200401404
POST
/v1/apps/{id}/webhook-config/rotate-secret
Rotate webhook secret
WorkspaceAppsController_rotateWebhookSecret 1 param → 200401404
GET
/v1/apps/{id}/providers
List activation summaries for all providers on an app
WorkspaceAppsController_listProviders 1 param → 200401404
GET
/v1/apps/{id}
Get app details
WorkspaceAppsController_getApp 1 param → 200401404
PATCH
/v1/apps/{id}
Patch app
WorkspaceAppsController_patchApp 1 param body → 200401404
DELETE
/v1/apps/{id}
Delete app
WorkspaceAppsController_deleteApp 1 param → 200401404
POST
/v1/apps/{id}/rotate-client-secret
Rotate client secret
WorkspaceAppsController_rotateClientSecret 1 param body → 201401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are WorkspaceAppDto (14 properties), WebhookConfigDto (6 properties), UpdateAppDto (6 properties), AppProviderSummaryDto (6 properties). Each schema is shown below with its type and property counts.

PaginatedAppsResponseDto
object
4 properties 4 required
WorkflowEntryDto
object
6 properties 4 required
FlowNodeDto
object
4 properties 2 required
WebhookConfigDto
object
6 properties 4 required
ListAppProvidersResponseDto
object
2 properties 2 required
CreateAppDto
object
1 property 1 required
WorkspaceAppDto
object
14 properties 10 required
BatchCreateAppsDto
object
2 properties 1 required
WorkspaceBatchCreateAppsResponseDto
object
3 properties 3 required
RotateClientSecretResponseDto
object
1 property 1 required
AppProviderSummaryDto
object
6 properties 6 required
UpdateAppDto
object
6 properties
BatchCreateAppItemDto
object
4 properties 1 required
UpdateWebhookConfigDto
object
5 properties
UpdateRedirectUrisDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hopae-inc-workspace-api-apps-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 - Activation API
Hopae, Inc. Workspace API - Production Tests API
Hopae, Inc. Workspace API - Workflows API
Hopae, Inc. Workspace API - Workspace API