Skip to main content
GET
List licenses needing attention
Returns the licences that need something done about them: active licences inside their state renewal window, plus licences already past due where a late-renewal or reinstatement path is still open. Entity-held and producer-held licences arrive in one list, soonest expiry first. Each row carries holderType, which tells you whether it refers to an entity or a producer. Filter with holderType to get one side only. expirationStatus is either expiring or expired, and there is no third value. A licence outside its renewal window does not appear on this list at all, and there is no row for a licence you do not hold: this list is work on licences you have, not a gap analysis against a requirement set. Licences you have marked as not-to-be-renewed are excluded. The agency surface has no webhooks, so polling this endpoint is the documented substitute (see Agency API).

Authorizations

Authorization
string
header
required

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

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"

holderType
enum<string>

Restrict to entity-held or producer-held licenses. Both are returned by default.

Available options:
entity,
producer
Example:

"producer"

Response

A page of licenses needing attention

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"