Apps

List apps

Returns a list of apps matching the query parameters.

get/api/apps

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
  • Auth: none declared

Query parameters

directorystring

Directory identifier (id or name). When unspecified apps from all directories are listed.

archivedboolean

true lists archived apps, false lists unarchived apps. When unspecified apps are listed regardless of their archived status.

memberstring

User identifier (id or uid). Used to list apps where specified user is member.

typestring[]

Can be used to list apps of a specified type (name or guid). When unspecifed all types of apps are listed.

uidboolean

true lists apps with a uid, false lists apps without uid. By default apps are listed whether they have a uid or not.

unreadboolean

true lists apps with unread messages, false lists apps where all messages are read. When unspecified apps are listed whether they have unread messages or not.

qstring

A string used to find matching items by name, e.g. q=test.

tagstring[]

List items with the specified tags. May be specified multiple times to list items matching any of the given tags, e.g. tag=a&tag=b.

trashedboolean

Indicates whether trashed items should be listed (default is false). Specify null to list both trashed and non-trashed items.

order_bystring

Specifies the sort order and direction for the listing, e.g. order_by=id or order_by=id+desc.

integer
OR
string int32

The number of items to skip. Used together with take to return a specific range of items (for pagination).

integer
OR
string int32

Maximum number of items to return in the listing. Should be a value between 1 and 100. Default is 25.

count_onlyboolean

true to count the number of matching items instead of listing them; when specified the response will only contain the count property.

Response

OK

Changes

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