Skip to main content
GET
List Apps (v1)

Authorizations

X-Domino-Api-Key
string
header
required

Query Parameters

projectId
string

The id of the project to retrieve apps for.

name
string

The name filter for the apps to retrieve.

includeTemplateApps
boolean
default:false
sortField
enum<string>
default:lastViewed
Available options:
name,
lastUpdated,
status,
views,
lastViewed
sortOrder
enum<string>
default:asc
Available options:
asc,
desc
limit
integer
offset
integer
default:0
ownerId
string
status
enum<string>
Available options:
Queued,
Scheduled,
Pending,
Preparing,
Building,
Pulling,
Running,
Serving,
StopRequested,
StopAndDiscardRequested,
Stopping,
Finishing,
Stopped,
Succeeded,
Failed,
Error
publisherId
string
tagIds
string[]
entryPoint
string

When provided, returns only Apps whose entryPoint matches this value exactly. Used by the publish-into-existing workflow to restrict the list to compatible Apps.

draftsOnly
boolean
default:false

When omitted or false, returns only published Apps. When true, returns only draft Apps that the caller is authorized to edit.

Response

Success

items
object[]
required
metadata
object
required