List entity licenses
Licenses
List Entity Licenses
The licences held by your legal entities
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
1-based page number
Required range:
x >= 1Example:
1
Page size (max 100)
Required range:
1 <= x <= 100Example:
50
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"
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"
License status
Available options:
active, inactive Example:
"active"