Skip to main content
GET
Producer licensing position by state
Returns your producers’ licensing position broken down by state: one row per producer and state, with the licence classes held and their standing. The same shared computation as the entity equivalent. List Producer Licenses returns the raw rows if you would rather compute your own.

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"

producerId
string

Narrow to a single producer. Returns an empty page if the producer is not one of yours.

Example:

"6627f2b5c2e0a51b8c0d4e7c"

Response

A page of per-state positions

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"