OMomni
Apps

Read app content

Changed on
<Note> This API is currently in development and may change. </Note>

Read the published app content, including its HTML and settings. The calling user or the user specified with the userId parameter must have view access to the app or the API will return an error.

The response can be used to create a draft. Read the draft state before building, as an existing draft may have diverged from the published version in the response.

get/v2/documents/{documentId}/app

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v2/documents/{documentId}/app
  • Auth
    HTTP bearer

Path parameters

documentIdstring required

The document's URL slug (e.g. abc123) or its canonical workbook UUID.

Query parameters

pretty'0' | '1' | 'true' | 'false'

Set true or 1 to pretty-print (2-space indent) the response; false / 0 is compact. Key ordering is deterministic regardless.

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Response

The published app content.

htmlstring required

The complete app HTML document.

Changes