Links

Get a control app's metadata

get
https://app.singular.live/apiv2/controlapps/:appToken
Get control app metadata

Response definitions

The following table describes each item in the response.
Response item
Description
Data type
id
The app's internal ID in the database.
Integer
userId
The ID of the user that created the app.
Integer
accountId
The account that the app is stored in.
Integer
thumbnail
The URL of the app's thumbnail preview on the Dashboard.
URL
updatedAt
The most recent time the app was updated.
String
createdAt
When the app was created.
String
type
The type of overlay, which for control apps is controlapp.
String
outputUrl
The app's output URL.
URL
broadcastOutputUrl
The app's broadcast output URL.
URL
publicControlUrl
The app's public control URL.
URL
publicControlApiUrl
The app's public control API URL.
URL
publicCommandUrl
The app's public command URL.
URL
publicModelApiUrl
The app's broadcast API URL.
URL
appTemplateId
The app's template ID.
Integer
appTemplateVersion
The app template version.
Integer
compositionJson
The composition JSON URL
URL
name
The app's name.
String
folder
The ID of the folder where the app lives.
String
compositionId
The ID of the composition linked to this app.
Integer