Get App
Get one app by its UUID.
The three workflow fields are always present, either as an { "id": ... } reference or as null when nothing is bound. Name one in expand to get its full definition inline instead. Fields you lack permission to read are left out of the response rather than returned as null, so absence and null carry different meanings here.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The app's ID, which GET /v1/apps returns as id.
Query Parameters
Fields to expand. Supported fields: admins, approval_workflow, default_provisioning_workflow, default_deprovisioning_workflow, custom_attributes, appstore_settings.
Response
Successful Response
The unique identifier of the app.
The display name of the app.
The catalog identifier of the underlying app (e.g. "github.com"). Custom apps return "custom".
The app-instance identifier distinguishing multiple instances of the same app.
URL of the app logo image.
URL of the app's official website.
The category this app belongs to.
A description of the app.
The lifecycle status of this app. One of discovered, in-review, needs-review, approved, blocklisted, deprecated.
discovered, in-review, needs-review, approved, blocklisted, deprecated Whether this app has been disconnected (its stored credentials removed via POST /v1/apps/{app_uuid}:disconnect). A disconnected app is excluded from GET /v1/apps?disconnected=false; reconnect it by sending credentials to PATCH /v1/apps/{app_uuid}.
The display name set for this app in your organization, exactly as written. label shows it when set. Null when the app uses its default name. A custom app has no default name, so on one this is always the name it shows.
The description set for this app in your organization, exactly as written. description shows it when set. Null when the app uses its default description. A custom app has no default description, so on one this is always the description it shows.
The category set for this app in your organization, exactly as written. category shows it when set. Null when the app uses its default category. A custom app has no default category, so on one this is always the category it shows.
The logo URL set for this app in your organization, exactly as written. logo_url shows it when set. Null when the app uses its default logo.
The website URL set for this app in your organization, exactly as written. website_url shows it when set. Null when the app uses its default website, if any.
Custom message shown to the requester after their access request is approved. Omitted when none is set.
Users and groups that administer this app. Only present when expand=admins is requested.
Response shape for a Workflow.
- Workflow
- WorkflowRef
Response shape for a Workflow.
- Workflow
- WorkflowRef
Response shape for a Workflow.
- Workflow
- WorkflowRef
AppStore membership and settings. Present when the caller has read access to AppStore items. Returns {in_app_store} by default; expand with expand=appstore_settings for the full settings object.
- AppStoreSettingsCompact
- AppStoreSettingsResponse
Custom attributes configured on this app. Only present when expand=custom_attributes is requested.
The state of this app's most recent sync: syncing while one is running, success or failed once it finished. Omitted when no sync result is recorded — the app has never synced, or was disconnected.
syncing, success, failed