List Accounts

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

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

fetch('https://api.lumos.com/v1/accounts', 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/accounts",
  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/accounts"

	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/accounts")

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

{
  "accounts": [
    {
      "id": "<string>",
      "app_id": "<string>",
      "account_type": "user",
      "unique_identifier": "<string>",
      "sources": [
        "google-workspace-quick-inbox"
      ],
      "status": "discovered",
      "email": "<string>",
      "user_id": "<string>",
      "discovered_at": "2023-11-07T05:31:56Z",
      "last_login": "2023-11-07T05:31:56Z",
      "last_activity": "2023-11-07T05:31:56Z",
      "app": {
        "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
      }
    }
  ],
  "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>"
      }
    ]
  }
}

Accounts

List Accounts

List all accounts associated with apps at your company, including accounts that match no user (their user_id is null), such as service accounts or uploaded accounts for people Lumos doesn’t know. Use has_user to narrow the list to one kind.

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.

Without expand=app the app key is omitted from each item. Returns 404 if app_id is unknown.

GET

accounts

List Accounts

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

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

fetch('https://api.lumos.com/v1/accounts', 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/accounts",
  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/accounts"

	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/accounts")

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

{
  "accounts": [
    {
      "id": "<string>",
      "app_id": "<string>",
      "account_type": "user",
      "unique_identifier": "<string>",
      "sources": [
        "google-workspace-quick-inbox"
      ],
      "status": "discovered",
      "email": "<string>",
      "user_id": "<string>",
      "discovered_at": "2023-11-07T05:31:56Z",
      "last_login": "2023-11-07T05:31:56Z",
      "last_activity": "2023-11-07T05:31:56Z",
      "app": {
        "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
      }
    }
  ],
  "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

app_id

string | null

Filter to accounts on this app.

discovered_before

string<date-time> | null

Filter to accounts whose discovered_at is at or before this time.

discovered_after

string<date-time> | null

Filter to accounts whose discovered_at is at or after this time.

sources

enum<string>[] | null

Filter to accounts discovered by these sources.

Available options:

google-workspace-quick-inbox,

google-workspace-deep-inbox,

microsoft-deep-inbox,

microsoft-oauth,

microsoft-gcc,

google-workspace-oauth,

okta,

manual,

onelogin,

atlassian,

google-cloud,

integration,

jumpcloud,

custom,

mcp,

native

string | null

Filter to accounts whose email (as reported by the app) matches this value. Matching is case-insensitive.

Minimum string length: 1

status

enum<string>[] | null

Filter to accounts in these lifecycle statuses.

Available options:

discovered,

staged,

access-created,

active,

archived,

suspended,

deprovisioned,

manually-removed,

access-removed,

non-corporate,

waiting-manual-removal

has_user

boolean | null

true lists only accounts matched to a user, false only accounts with no user. Omit to list both.

expand

string[] | null

Fields to expand. Supported fields: app.

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:50

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

Required range: x >= 1

Response

Successful Response

A page of accounts, each carrying the full v1 account payload.

accounts

Account · object[]

required

Accounts 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 Accounts

Authorizations

Query Parameters

Response