List entity appointments
Appointments
List Entity Appointments
Carrier appointments held by your legal entities
GET
List entity appointments
Returns the carrier appointments held by your entities: which carrier, which state, which lines, and the appointment’s standing.
Like entity licences, appointments are keyed on the entity’s compliance data subscription rather than on the entity id directly. An entity with no NPN has no subscription and therefore no appointments.
Narrowing
downstreamEntityId, stateCode and status.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"
Appointment status
Available options:
terminated, appointed Example:
"appointed"
The carrier's company code. Filter on this rather than carrierName, which comes off the NIPR record unnormalised and can spell one carrier several ways.
Example:
"12345"