Skip to main content
GET
List entity licenses
Returns the state licences held by your entities, sourced from NIPR and refreshed by Turris.
Entity licences are keyed on a compliance data subscription, not on an entity id. Each of your entities has its own subscription, and the licence rows hang off that. You do not need to handle this — the API resolves it — but it explains why a brand-new entity with no NPN never returns licences: no NPN means no subscription, and no subscription means nothing to sync.

Narrowing

downstreamEntityId limits the list to one entity. stateCode and status filter within it.

Query Parameters

page
number
default:1

1-based page number

Required range: x >= 1
Example:

1

limit
number
default:50

Page size (max 100)

Required range: 1 <= x <= 100
Example:

50

downstreamEntityId
string

Narrow the results to a single entity in your organization. Defaults to your whole subtree (your entity plus every branch beneath it). Returns 404 if the id is not in your subtree.

Example:

"6610b3d2c2e0a51b8c0d1f02"

stateCode
enum<string>

Two-letter state or territory code

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY,
GU,
PR,
VI,
DC
Example:

"PA"

status
enum<string>

License status

Available options:
active,
inactive
Example:

"active"

Response

A page of entity licenses

data
object
required
requestId
string
required

Unique request identifier

Example:

"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8"

timestamp
string
required

Response timestamp

Example:

"2025-11-12T20:49:03.293Z"