Get a control app's metadata

Get control app metadata

GET https://app.singular.live/apiv2/controlapps/:appToken

Returns the metadata of a control app instance.

Path Parameters

Name	Type	Description
appToken*	String	The shared app token for the app. This is a unique token for this app instance. How to find the shared app token.

200: OK JSON payload

{
  "id": 1630476,
  "userId": 25290,
  "accountId": 22123,
  "thumbnail": "//image.singular.live/fit-in/150x150/f12f184c9a0eb763beb40478e02a1250/images/4GcvLpm2JA5lUFrshMO7vK.png",
  "updatedAt": "2022-09-26T10:41:36.000Z",
  "createdAt": "2022-09-22T15:46:54.000Z",
  "type": "controlapp",
  "outputUrl": "https://app.singular.live/output/3AVwVLk51gGVCFWckgBcti/Output?aspect=16:9",
  "broadcastOutputUrl": "https://app.singular.live/output/3AVwVLk51gGVCFWckgBcti/Broadcast?aspect=16:9",
  "publicControlUrl": "https://app.singular.live/control/1H7sRGX6UhgQHlAgtAXTB6",
  "publicControlApiUrl": "https://app.singular.live/apiv2/controlapps/1H7sRGX6UhgQHlAgtAXTB6/control",
  "publicCommandUrl": "https://app.singular.live/apiv2/controlapps/1H7sRGX6UhgQHlAgtAXTB6/command",
  "publicModelApiUrl": "https://app.singular.live/apiv2/controlapps/1H7sRGX6UhgQHlAgtAXTB6/model",
  "appTemplateId": 518,
  "appTemplateVersion": 10,
  "name": "REST-Control Node Field Types app",
  "folder": "7623f754-e32a-48f8-8d2d-46105df16ea0",
  "compositionId": 454606
}

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