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,
published
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.

configurationType
enum<string>

Filter apps by configuration type. Single-select.

Available options:
STANDARD,
AISYSTEM
accessStatus
enum<string>

Filter apps by the current user's access status. Single-select. granted - the user can access the app. pending - the user has an outstanding access request. noAccess - the user has no access and no pending request.

Available options:
granted,
pending,
noAccess
prioritizePinned
boolean
default:true

When true (default), pinned apps are moved to the front of the sorted results. Pass false to leave them in their sorted position.

Response

Success

items
object[]
required
metadata
object
required
Last modified on October 8, 2026