List Entitlements

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

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

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

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

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

{
  "entitlements": [
    {
      "id": "<string>",
      "app_id": "<string>",
      "label": "<string>",
      "entitlement_type_label": "<string>",
      "source": "google-workspace-quick-inbox",
      "description": "<string>",
      "description_override": "<string>",
      "approval_workflow_override": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "provisioning_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "deprovisioning_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "custom_approval_message_override": "<string>",
      "appstore_settings": {
        "visible_in_appstore": true,
        "allowed_requester_group_uuids_override": [
          "<string>"
        ],
        "time_based_access_override": {
          "options": [
            {
              "label": "<string>",
              "value_seconds": 123
            }
          ]
        },
        "request_validation_webhook_uuid": "<string>"
      }
    }
  ],
  "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>"
      }
    ]
  }
}

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

Entitlements

List Entitlements

List every entitlement across your organization — roles, licenses, groups, and other access rights — spanning every app.

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.

A page can hold fewer items than page_size while more results remain. Treat an absent next_page_token, not a short page, as the end of the list.

A request that takes too long to answer, such as a search that matches few entitlements in a large organization, returns 422 with code entitlements.list_too_broad. Narrow the search, or list one app’s entitlements with GET /v1/apps/{app_uuid}/entitlements.

GET

entitlements

List Entitlements

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

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

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

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

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

{
  "entitlements": [
    {
      "id": "<string>",
      "app_id": "<string>",
      "label": "<string>",
      "entitlement_type_label": "<string>",
      "source": "google-workspace-quick-inbox",
      "description": "<string>",
      "description_override": "<string>",
      "approval_workflow_override": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "provisioning_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "deprovisioning_workflow": {
        "id": "<string>",
        "type": "approval",
        "steps": [
          {
            "step": "<string>",
            "inputs": {},
            "name": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "app_id": "<string>"
      },
      "custom_approval_message_override": "<string>",
      "appstore_settings": {
        "visible_in_appstore": true,
        "allowed_requester_group_uuids_override": [
          "<string>"
        ],
        "time_based_access_override": {
          "options": [
            {
              "label": "<string>",
              "value_seconds": 123
            }
          ]
        },
        "request_validation_webhook_uuid": "<string>"
      }
    }
  ],
  "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>"
      }
    ]
  }
}

{
  "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: approval_workflow_override, provisioning_workflow, deprovisioning_workflow, appstore_settings.

visible_in_appstore

boolean | null

Filter by AppStore catalog visibility. When present, only entitlements configured in the AppStore catalog are considered: true returns those visible in the catalog, false those hidden from it. An entitlement on an app that isn't in the AppStore counts as hidden. Entitlements that aren't configured in the AppStore catalog at all are excluded either way. Omit this filter to return every entitlement regardless of AppStore configuration. Requires the AppStore item settings read permission across your organization.

string | null

Case-insensitive substring match against the entitlement's label. Resend it with each page_token.

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

entitlements

EntitlementOutput · object[]

required

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

Authorizations

Query Parameters

Response