Skip to main content
GET
Get App

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_uuid
string
required

The app's ID, which GET /v1/apps returns as id.

Query Parameters

expand
string[] | null

Fields to expand. Supported fields: admins, approval_workflow, default_provisioning_workflow, default_deprovisioning_workflow, custom_attributes, appstore_settings.

Response

Successful Response

id
string
required

The unique identifier of the app.

label
string | null

The display name of the app.

app_class_id
string | null

The catalog identifier of the underlying app (e.g. "github.com"). Custom apps return "custom".

instance_id
string | null

The app-instance identifier distinguishing multiple instances of the same app.

logo_url
string | null

URL of the app logo image.

website_url
string | null

URL of the app's official website.

category
string | null

The category this app belongs to.

description
string | null

A description of the app.

status
enum<string> | null

The lifecycle status of this app. One of discovered, in-review, needs-review, approved, blocklisted, deprecated.

Available options:
discovered,
in-review,
needs-review,
approved,
blocklisted,
deprecated
disconnected
boolean
default:false

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}.

label_override
string | null

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.

description_override
string | null

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.

category_override
string | null

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.

logo_url_override
string | null

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.

website_url_override
string | null

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.

post_approval_message
string | null

Custom message shown to the requester after their access request is approved. Omitted when none is set.

admins
AdminAssignee · object[] | null

Users and groups that administer this app. Only present when expand=admins is requested.

approval_workflow
Workflow · object

Response shape for a Workflow.

default_provisioning_workflow
Workflow · object

Response shape for a Workflow.

default_deprovisioning_workflow
Workflow · object

Response shape for a Workflow.

appstore_settings
AppStoreSettingsCompact · object

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.

custom_attributes
Custom Attributes · object | null

Custom attributes configured on this app. Only present when expand=custom_attributes is requested.

sync_status
enum<string> | null

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.

Available options:
syncing,
success,
failed