Skip to main content

List Apps

GET 
/api/apps/

List all apps on the environment.

Request​

Query Parameters

    limit integer

    Number of results to return per page.

    offset integer

    The initial index from which to return the results.

    detail_level string

    Possible values: [minimal, basic, full]

    Default value: full

    Response detail level. See :ref:Response detail levels <response detail levels target> for detail of detail levels.

    maintainer integer[]

    Filter on maintainer ID.

    label integer[]

    Filter on label ID.

    sort string[]

    Possible values: [is_verified, is_verified:asc, is_verified:desc, created_at, created_at:asc, created_at:desc, readable_name, readable_name:asc, readable_name:desc, name, name:asc, name:desc, views, views:asc, views:desc, views_last_30_days, views_last_30_days:asc, views_last_30_days:desc, dev_connect, dev_connect:asc, dev_connect:desc]

    Sort by name | readable_name | created_at | views | views_last_30_days | is_verified | dev_connect. Sort terms accept for :asc and :desc suffixes. Client can also provide more than one sort term to sort by multiple fields.

    search string

    Possible values: non-empty

    Allow for fuzzy name match.

    is_published boolean

    Filter by published status of the app.

    include_archived boolean

    Whether or not to include archived apps. Requires org admin permission.

    is_verified boolean

    Filter by app is_verified filter.

    is_public boolean

    Filter by public apps.

Responses​

Schema

    count integerrequired

    Count of all the objects in the result set.

    next string

    Next url.

    previous string

    Previous url.

    results

    object[]

    required

  • Array [

    • id integer
    name string

    Possible values: non-empty

    short_name string

    Possible values: non-empty

    full_name string

    Possible values: non-empty

    readable_name stringrequired

    Possible values: non-empty and <= 64 characters

    A human-readable name for the app.

    description stringrequired

    A description about the app and its usage.

    long_description string

    A long description about the app and its usage.

    is_verified boolean
    is_public boolean

    Whether the app is public.

    public_workspace_slug string

    Possible values: non-empty

    Public workspace slug for building URLs

    allow_personal_workers boolean

    Whether the app allows the use of personal workers in production workspaces.

    repository_url urinullable

    Possible values: <= 512 characters

    The repository url which app is maintained on.

    repository_host_platform string

    Possible values: [github, gitlab, azure, bitbucket, other]

    Repository url host platform.

    created_from string

    Possible values: non-empty

    App creation source. This can be either one of scratch, app_builder, app_template, excel_converter

    maintainers integer[]required
    created_at date-time

    Application creation date. The value is in ISO 8601 format.

    icon stringrequired

    Possible values: non-empty

    images objectrequired
    latest_app_version objectnullable
    latest_published_app_version objectnullable
    org_domain string

    Possible values: non-empty

    org_name string

    Possible values: non-empty

    is_archived boolean

    Returns whether the app is archived.

    is_out_of_sync boolean

    labels

    object[]

  • Array [

    • id integer
    name stringrequired

    Possible values: non-empty and <= 30 characters

    description string

    Possible values: <= 100 characters

    color stringrequired

    Possible values: non-empty and <= 6 characters

    number_of_apps integer
    number_of_workspaces integer

  • ]

    • nr_views integer

    The calculated total daily unique sessions in case of internal/private workspace, and the number of views (count editor sessions) in case of public workspace, for all workspaces associated with this app

    nr_views_last_30_days integer

    The calculated total daily unique sessions in case of internal/private workspace, and the number of views (count editor sessions) in case of public workspace, for all workspaces associated with this app (over the last 30 days)

    resources object

    Resource limits applied on this app.

    dev_workspace integer

    The development workspace for dev + app

    dev_last_connected_at integer

    The timestamp of the most recent development for dev + app

    test_workspace integer

    App's test workspace.

    enable_test_workspace boolean

    Whether the app has a test workspace

    project_count integer

  • ]

Loading...