Apps

Get app

Get details for the specified app.

get/api/apps/{app}

Request

  • Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.weavy.com/api/apps/{app}
  • Auth: none declared

Path parameters

appstring required

App identifier (id or uid).

Query parameters

trashedboolean

true to return app even if trashed (default is false).

Response

OK

typestring uuid nullable

The app type.

uidstring nullable

The unique identifier for the app.

namestring nullable

Gets the name.

descriptionstring nullable

Gets the description text.

archive_urlstring nullable

Url to zip-archive with files in the app.

avatar_urlstring nullable

Gets a thumbnail image.

metadataobject nullable
tagsstring[] nullable
accessunknown
created_atstring date-time nullable

Date and time (UTC) when the app was created.

updated_atstring date-time nullable

Date and time (UTC) when the app was last updated.

is_pinnedboolean nullable

If the authenticated user has pinned this app.

is_starredboolean nullable

If the authenticated user has starred the app.

is_subscribedboolean nullable

If the authenticated user has subscribed to the app.

is_trashedboolean nullable

Is the app trashed or not.

is_unreadboolean nullable

If the authenticated user has unread messages in the app.

permissionsPermission[] nullable

Gets app permissions for the authenticated user.

Changes

No recorded changes to this operation across all 1 revision of this API.