Skip to content
Hyperproof API
/
/
Get Custom App

Custom Apps API (1.0)

Provides access to apps that are installed in an organization.

Download OpenAPI description
customapps.openapi.json
customapps.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/custom-apps/customapps.openapi
Hyperproof US
https://api.hyperproof.app/v1/customapps
Hyperproof Gov
https://api.hyperproofgov.app/v1/customapps
Hyperproof EU
https://api.hyperproof.eu/v1/customapps

Get Custom Apps

Request

GET /

Description

Retrieves details of custom apps installed in an organization, including their configurations, statuses, and integration metadata.

Security
oauth2
curl -i -X GET \
  https://developer.hyperproof.app/_mock/hyperproof-api/custom-apps/customapps.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
appIdstring(uuid)

The unique identifier for the custom app.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
appTypestring

The type of custom app.

Enum"hypersync""taskIntegration""folderIntegration"
Example: "hypersync"
isCustomboolean

Indicates whether the app is custom.

Example: true
orgIdstring(uuid)

The unique identifier for the organization the custom app belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
packageNamestring

The package name of the custom app.

Example: "Name of the package"
packageVersionstring

The version of the custom app package.

Example: "1.0"
deploymentStatusstring

The deployment status of the custom app.

Enum"pending""deployed""failed"
Example: "deployed"
createdBystring

The unique identifier of the user who created the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the custom app was created (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
updatedBystring

The unique identifier of the user who last updated the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the custom app was last updated (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
statusstring

The status of the custom app.

Enum"active""deleted"
Example: "active"
]
Response
application/json
[
  {
    "appId": "string",
    "appType": "hypersync",
    "isCustom": true,
    "orgId": "string",
    "packageName": "string",
    "packageVersion": "1.0",
    "deploymentStatus": "deployed",
    "createdBy": "string",
    "createdOn": "string",
    "updatedBy": "string",
    "updatedOn": "string",
    "status": "active"
  }
]

Add Custom App

Request

POST /

Description

Creates and registers a new custom app within an organization, storing details such as the app’s name, configuration, and integration parameters.

Security
oauth2
curl -i -X POST \
  https://developer.hyperproof.app/_mock/hyperproof-api/custom-apps/customapps.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
appIdstring(uuid)

The unique identifier for the custom app.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
appTypestring

The type of custom app.

Enum"hypersync""taskIntegration""folderIntegration"
Example: "hypersync"
isCustomboolean

Indicates whether the app is custom.

Example: true
orgIdstring(uuid)

The unique identifier for the organization the custom app belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
packageNamestring

The package name of the custom app.

Example: "Name of the package"
packageVersionstring

The version of the custom app package.

Example: "1.0"
deploymentStatusstring

The deployment status of the custom app.

Enum"pending""deployed""failed"
Example: "deployed"
createdBystring

The unique identifier of the user who created the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the custom app was created (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
updatedBystring

The unique identifier of the user who last updated the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the custom app was last updated (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
statusstring

The status of the custom app.

Enum"active""deleted"
Example: "active"
Response
application/json
{
  "appId": "string",
  "appType": "hypersync",
  "isCustom": true,
  "orgId": "string",
  "packageName": "string",
  "packageVersion": "1.0",
  "deploymentStatus": "deployed",
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string",
  "status": "active"
}

Get Custom App

Request

GET /{appId}

Description

Retrieves details of a specific custom app installed in an organization, including its configuration, status, and integration metadata.

Security
oauth2
Path
appIdstringrequired

Unique ID of the custom app.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/custom-apps/customapps.openapi/{appId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
appIdstring(uuid)

The unique identifier for the custom app.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
appTypestring

The type of custom app.

Enum"hypersync""taskIntegration""folderIntegration"
Example: "hypersync"
isCustomboolean

Indicates whether the app is custom.

Example: true
orgIdstring(uuid)

The unique identifier for the organization the custom app belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
packageNamestring

The package name of the custom app.

Example: "Name of the package"
packageVersionstring

The version of the custom app package.

Example: "1.0"
deploymentStatusstring

The deployment status of the custom app.

Enum"pending""deployed""failed"
Example: "deployed"
createdBystring

The unique identifier of the user who created the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the custom app was created (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
updatedBystring

The unique identifier of the user who last updated the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the custom app was last updated (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
statusstring

The status of the custom app.

Enum"active""deleted"
Example: "active"
Response
application/json
{
  "appId": "string",
  "appType": "hypersync",
  "isCustom": true,
  "orgId": "string",
  "packageName": "string",
  "packageVersion": "1.0",
  "deploymentStatus": "deployed",
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string",
  "status": "active"
}

Update Custom App

Request

PATCH /{appId}

Description

Updates the configuration or metadata of a custom app installed in an organization, allowing modifications to settings, permissions, or integration details.

Security
oauth2
Path
appIdstringrequired

Unique ID of the custom app.

curl -i -X PATCH \
  'https://developer.hyperproof.app/_mock/hyperproof-api/custom-apps/customapps.openapi/{appId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
appIdstring(uuid)

The unique identifier for the custom app.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
appTypestring

The type of custom app.

Enum"hypersync""taskIntegration""folderIntegration"
Example: "hypersync"
isCustomboolean

Indicates whether the app is custom.

Example: true
orgIdstring(uuid)

The unique identifier for the organization the custom app belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
packageNamestring

The package name of the custom app.

Example: "Name of the package"
packageVersionstring

The version of the custom app package.

Example: "1.0"
deploymentStatusstring

The deployment status of the custom app.

Enum"pending""deployed""failed"
Example: "deployed"
createdBystring

The unique identifier of the user who created the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the custom app was created (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
updatedBystring

The unique identifier of the user who last updated the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the custom app was last updated (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
statusstring

The status of the custom app.

Enum"active""deleted"
Example: "active"
Response
application/json
{
  "appId": "string",
  "appType": "hypersync",
  "isCustom": true,
  "orgId": "string",
  "packageName": "string",
  "packageVersion": "1.0",
  "deploymentStatus": "deployed",
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string",
  "status": "active"
}

Deletes Custom App

Request

DEL /{appId}

Description

Removes an existing custom app from an organization, permanently deleting its configuration, metadata, and associated integrations.

Security
oauth2
Path
appIdstringrequired

Unique ID of the custom app.

curl -i -X DELETE \
  'https://developer.hyperproof.app/_mock/hyperproof-api/custom-apps/customapps.openapi/{appId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
appIdstring(uuid)

The unique identifier for the custom app.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
appTypestring

The type of custom app.

Enum"hypersync""taskIntegration""folderIntegration"
Example: "hypersync"
isCustomboolean

Indicates whether the app is custom.

Example: true
orgIdstring(uuid)

The unique identifier for the organization the custom app belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
packageNamestring

The package name of the custom app.

Example: "Name of the package"
packageVersionstring

The version of the custom app package.

Example: "1.0"
deploymentStatusstring

The deployment status of the custom app.

Enum"pending""deployed""failed"
Example: "deployed"
createdBystring

The unique identifier of the user who created the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the custom app was created (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
updatedBystring

The unique identifier of the user who last updated the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the custom app was last updated (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
statusstring

The status of the custom app.

Enum"active""deleted"
Example: "active"
Response
application/json
{
  "appId": "string",
  "appType": "hypersync",
  "isCustom": true,
  "orgId": "string",
  "packageName": "string",
  "packageVersion": "1.0",
  "deploymentStatus": "deployed",
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string",
  "status": "active"
}

Get Custom App Events

Request

GET /{appId}/events

Description

Retrieves log events generated by a specified custom app, providing details such as timestamps, event types, and messages for monitoring and troubleshooting.

Security
oauth2
Path
appIdstringrequired

Unique ID of the custom app.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/custom-apps/customapps.openapi/{appId}/events' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring(uuid)

The unique identifier for the log event.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
timestampstring(date-time)

The timestamp of when the log event occurred (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
levelstring

The severity of the log event.

Enum"debug""info""warning""error"
Example: "debug"
messagestring

The log event message.

Example: "Log event message"
detailstring

Detailed description of the log event.

Example: "Log event detail"
orgIdstring(uuid)

The unique identifier for the organization.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
userIdstring(uuid)

The unique identifier for the user who uploaded the custom app

Example: "d2363cab-5199-11ee-a644-522476618ae8"
]
Response
application/json
[
  {
    "id": "string",
    "timestamp": "string",
    "level": "info",
    "message": "string",
    "detail": "string",
    "orgId": "string",
    "userId": "string"
  }
]

Get Custom App Statistics

Request

GET /{appId}/stats

Description

Retrieves usage and performance statistics for a specified custom app, including metrics such as request counts, error rates, and response times.

Security
oauth2
Path
appIdstringrequired

Unique ID of the custom app.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/custom-apps/customapps.openapi/{appId}/stats' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
appIdstring(uuid)

The unique identifier for the custom app.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
appTypestring

The type of custom app.

Enum"hypersync""taskIntegration""folderIntegration"
Example: "hypersync"
isCustomboolean

Indicates whether the app is custom.

Example: true
orgIdstring(uuid)

The unique identifier for the organization the custom app belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
packageNamestring

The package name of the custom app.

Example: "Name of the package"
packageVersionstring

The version of the custom app package.

Example: "1.0"
deploymentStatusstring

The deployment status of the custom app.

Enum"pending""deployed""failed"
Example: "deployed"
createdBystring

The unique identifier of the user who created the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the custom app was created (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
updatedBystring

The unique identifier of the user who last updated the custom app.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the custom app was last updated (ISO-8601 format).

Example: "2025-01-12T18:26:10.00.5365Z"
statusstring

The status of the custom app.

Enum"active""deleted"
Example: "active"
Response
application/json
{
  "appId": "string",
  "appType": "hypersync",
  "isCustom": true,
  "orgId": "string",
  "packageName": "string",
  "packageVersion": "1.0",
  "deploymentStatus": "deployed",
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string",
  "status": "active"
}
® 2026 Hyperproof All Rights Reserved.