List Apps

curl --request GET \
  --url https://api.lumos.com/v1/apps \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lumos.com/v1/apps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumos.com/v1/apps",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumos.com/v1/apps"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/v1/apps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "apps": [
    {
      "id": "<string>",
      "label": "<string>",
      "app_class_id": "<string>",
      "instance_id": "<string>",
      "logo_url": "<string>",
      "website_url": "<string>",
      "category": "<string>",
      "description": "<string>",
      "status": "discovered",
      "disconnected": false,
      "label_override": "<string>",
      "description_override": "<string>",
      "category_override": "<string>",
      "logo_url_override": "<string>",
      "website_url_override": "<string>",
      "post_approval_message": "<string>",
      "admins": [
        {
          "id": "<string>",
          "type": "user"
        }
      ],
      "approval_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "default_provisioning_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "default_deprovisioning_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "appstore_settings": {
        "in_app_store": true
      },
      "custom_attributes": {},
      "sync_status": "syncing"
    }
  ],
  "next_page_token": "<string>"
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Apps

List Apps

List apps in the caller’s organization.

Paginated via opaque cursor: pass the next_page_token value from the previous response back as the page_token query parameter to fetch the next page. When next_page_token is null, the current page is the last one.

Filter to apps flagged for the AppStore with in_app_store=true (or apps not so flagged with in_app_store=false). This is the admin-management flag rather than end-user catalog visibility — see GET /v1/apps/appstore-catalog for the set of apps actually visible to a given user’s AppStore. Per-entitlement catalog visibility is a separate setting: visible_in_appstore on GET /v1/apps/{app_uuid}/entitlements.

GET

apps

List Apps

curl --request GET \
  --url https://api.lumos.com/v1/apps \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lumos.com/v1/apps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumos.com/v1/apps",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumos.com/v1/apps"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/v1/apps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "apps": [
    {
      "id": "<string>",
      "label": "<string>",
      "app_class_id": "<string>",
      "instance_id": "<string>",
      "logo_url": "<string>",
      "website_url": "<string>",
      "category": "<string>",
      "description": "<string>",
      "status": "discovered",
      "disconnected": false,
      "label_override": "<string>",
      "description_override": "<string>",
      "category_override": "<string>",
      "logo_url_override": "<string>",
      "website_url_override": "<string>",
      "post_approval_message": "<string>",
      "admins": [
        {
          "id": "<string>",
          "type": "user"
        }
      ],
      "approval_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "default_provisioning_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "default_deprovisioning_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "appstore_settings": {
        "in_app_store": true
      },
      "custom_attributes": {},
      "sync_status": "syncing"
    }
  ],
  "next_page_token": "<string>"
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

expand

string[] | null

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

page_token

string | null

Opaque cursor from a previous response's next_page_token. Omit to fetch the first page. Treat as opaque: do not decode, construct, or interpret it.

page_size

integer

default:100

Maximum number of items to return per page. Values above 250 are clamped to 250 rather than rejected.

Required range: x >= 1

catalog_visibility

enum<string> | null

Filter by the app's appstore_settings.catalog_visibility (visible, search-only or hidden). Pair it with in_app_store=true to list the AppStore by visibility; "Who Can Request" groups don't narrow this list.

Available options:

visible,

search-only,

hidden

connection_source

enum<string> | null

Filter to integrations connected via this source (api or ui).

Available options:

api,

ui

disconnected

boolean | null

Filter on whether the app has been disconnected. false excludes disconnected apps, true returns only disconnected apps whose record Lumos still holds, and omitting it lists every app. Pair false with connection_source=api to list only the connected apps you manage through the API.

in_app_store

boolean | null

Filter by AppStore membership. true returns only apps in the AppStore; false returns only apps not in the AppStore; omit for all apps.

string | null

Case-insensitive substring match against the app's label, instance identifier, and app class ID. Resend it with each page_token.

Response

Successful Response

apps

AppResponse · object[]

required

Apps returned in this page.

Show child attributes

next_page_token

string | null

Token for the next page, or null when this is the last page. An absent token is the only end-of-results signal. A page holding fewer than page_size items does not mean the results are exhausted. Treat the value as opaque: do not decode, construct, or interpret it.

Quick Start

Lumos API

API Reference

Guides

Migrate from v0

Lumos Connectors

Webhooks

Tools

List Apps

Authorizations

Query Parameters

Response