List producer licenses
Licenses
List Producer Licenses
The licences held by your producers
GET
List producer licenses
Returns the state licences held by the producers associated with your entities.
Scope follows the association, not the producer: you see the licences of producers associated with your entities, and each association carries its own compliance data subscription. A producer who leaves your agency stops appearing once the association is archived, without their licence records changing.
Narrowing
producerId limits the list to one producer, downstreamEntityId to producers at one entity, and stateCode / status filter within either.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"
Narrow to a single producer. Returns an empty page if the producer is not associated with your organization, which is the same response as a producer that does not exist.
Example:
"6627f2b5c2e0a51b8c0d4e7c"