SDK Apps

List Apps

get
/sdk/apps

Retrieves a collection of all apps available to the authenticated user.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
opensourcebooleanOptional

If set to true, this parameter returns apps available to all users. If set to false, it retrieves the apps available to the authenticated user.

Responses
200

Successful response

application/json
get
/sdk/apps
200

Successful response

Create App

post
/sdk/apps

Creates a new app with data passed in the request body. In the response, it returns all details of the created app.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body
Responses
200

Successful response

application/json
post
/sdk/apps
200

Successful response

Get App

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Query parameters
Responses
200

Successful response

application/json
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}
200

Successful response

Delete App

delete
/sdk/apps/{SDK_appName}/{SDK_appVersion}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Responses
200

Successful response

application/json
delete
/sdk/apps/{SDK_appName}/{SDK_appVersion}
200

Successful response

Patch App

patch
/sdk/apps/{SDK_appName}/{SDK_appVersion}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Body
objectOptional
Responses
200

Successful response

application/json
patch
/sdk/apps/{SDK_appName}/{SDK_appVersion}
200

Successful response

Clone App

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/clone
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Body
newNamestringOptional
newVersionintegerOptional
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/clone
200

Successful response

Get App Review

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/review
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Responses
200

Successful response

application/json
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/review
200

Successful response

Request Review

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/review
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Query parameters
allbooleanOptionalExample: true
Header parameters
Content-TypestringOptionalExample: application/json
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/review
200

Successful response

Submit App Review Form

put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/review/form
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
Body
testingScenariosobjectOptional
Responses
200

Successful response

application/json
put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/review/form
200

Successful response

Get App Events Log

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/events-log
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Query parameters
Responses
200

Successful response

application/json
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/events-log
200

Successful response

Get App Common

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/common

Get app client id and client secret.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired

The numeric version of the app.

SDK_appVersionintegerRequired

The numeric version of the app.

Example: 1
Responses
200

Successful response

application/json
Responseobject
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/common
200

Successful response

Set app common data

put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/common

Sets the common data for the app based on the parameters passed in the request body. In the response, it returns all details of common data. Common data usually contain sensitive information like API keys or API secrets and these details are shared across all modules.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired

The name of the app.

SDK_appVersionintegerRequired

The app version.

Body
objectOptional

The JSON object containing the common data.

Responses
200

Successful response

application/json
put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/common
200

Successful response

Get App Docs

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/readme
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Query parameters
allbooleanOptionalExample: true
Responses
200

Successful response

text/markdown
Responsestring
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/readme
200

Successful response

Set App Docs

put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/readme
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
Query parameters
allbooleanOptionalExample: true
Header parameters
Content-TypestringOptionalExample: text/markdown
Body
stringOptionalExample: I see you.
Responses
200

Successful response

application/json
put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/readme
200

Successful response

Set App Base

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/base

Set app base configuration.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Header parameters
Content-TypestringOptionalExample: application/jsonc
Body
or
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/base
200

Successful response

Patch App Base

patch
/sdk/apps/{SDK_appName}/{SDK_appVersion}/base

Patch app base configuration.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Header parameters
Content-TypestringOptionalExample: application/jsonc
Body
or
Responses
200

Successful response

application/json
patch
/sdk/apps/{SDK_appName}/{SDK_appVersion}/base
200

Successful response

Set App Section

put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/groups

Available sections: base, groups, install, installSpec

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Bodyobject[]
labelstringRequired
modulesstring[]Required
Responses
200

Successful response

application/json
put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/groups
200

Successful response

Set App Section

put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/install

Available sections: base, groups, install, installSpec

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Body
anyOptional
Responses
200

Successful response

application/json
put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/install
200

Successful response

Set App Visibility

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/{SDK_appVisibility}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
SDK_appVisibilitystring · enumRequiredPossible values:
Body
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/{SDK_appVisibility}
200

Successful response

Set App Opensource

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/opensource

beta, stable

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Header parameters
Content-TypestringOptionalExample: text/plain
Body
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/opensource
200

Successful response

Set App ClosedSource

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/closedsource
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Body
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/closedsource
200

Successful response

Get Change

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/changes/{SDK_changeId}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
SDK_changeIdintegerRequired
Responses
200

Successful response

application/json
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/changes/{SDK_changeId}
200

Successful response

Commit Changes

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/commit
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Header parameters
Content-TypestringOptionalExample: application/json
Body
messagestringOptional
notifybooleanOptional
changeIdsinteger[]Optional
Responses
200

Successful response

text/plain
Responseboolean
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/commit
200

Successful response

Rollback Changes

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rollback
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Header parameters
Content-TypestringOptionalExample: application/json
Body
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rollback
200

Successful response

Get App Logo

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/icon/{SDK_appIconSize}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
SDK_appIconSizeintegerRequired
Responses
200

Successful response

image/png
Responsestring · binary
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/icon/{SDK_appIconSize}
200

Successful response

Set App Logo

put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/icon
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Body
string · binaryOptional
Responses
200

Successful response

application/json
put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/icon
200

Successful response

Uninstall App from Organization

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/uninstall
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionintegerRequired
Body
organizationIdintegerOptional
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/uninstall
200

Successful response

Last updated