---
title: "ProducerSync API"
url: "https://developer.agentsync.io/apis/producer-sync-api/versions/bd45d597-3d48-4686-84a0-951d85a33e1e"
---

# ProducerSync API

OpenAPI specification document.

```json
{"openapi":"3.1.1","info":{"title":"ProducerSync API","version":"v2.68.24"},"servers":[{"url":"https://api.sandbox.agentsync.io","description":"Sandbox"}],"tags":[{"name":"NPN Management","description":"manage the list of subscribed NPNs that your account has access to"},{"name":"Producer Addresses","description":"Address information for producers"},{"name":"Producer Appointments","description":"Appointment information for producers"},{"name":"Producer Contact Information","description":"Contact information for producers"},{"name":"Producer Entities","description":"Entity information for producers"},{"name":"Producer Licenses and LOAs","description":"License and LOA information for producers"},{"name":"Producer Other Names","description":"Other names information for producers"},{"name":"Producer Regulatory Actions","description":"Regulatory actions information for producers"}],"paths":{"/v1/accounts/subscriptions":{"get":{"tags":["NPN Management"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getActiveNpns","summary":"Get active NPNs subscribed to the account","description":"Returns a list of active NPNs associated with the account.\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["1618516","16211","227714","228855","229777","117232"]}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"404":{"$ref":"#/components/responses/404NotFound"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}},"post":{"tags":["NPN Management"],"x-internal":false,"x-audience":["customer"],"operationId":"replaceActiveNpns","summary":"Replace the list of active NPNs subscribed to the account","description":"Replaced the current list of active NPNs with the new list provided in the request. This request will delete and add NPNs.\nThis operation is asynchronous\n","requestBody":{"required":true,"description":"The list of NPNs to activate","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["912484758","123456689","999999999"]}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription200"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":404},"timestamp":{"type":"integer","example":1744654402},"message":{"type":"string","example":"Account Not Found"},"path":{"type":"string","example":"/v1/accounts/subscriptions"},"error":{"type":"string","example":"Not Found"}}}}}},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}},"put":{"tags":["NPN Management"],"x-internal":false,"x-audience":["customer"],"operationId":"appendActiveNpns","summary":"Append to the list of active NPNs subscribed to the account","description":"Append to the current list of active NPNs with the new list provided in the request.\nThis operation is asynchronous\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["912484758","123456689","999999999"]}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription200"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":404},"timestamp":{"type":"integer","example":1744654402},"message":{"type":"string","example":"Account Not Found"},"path":{"type":"string","example":"/v1/accounts/subscriptions"},"error":{"type":"string","example":"Not Found"}}}}}},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}},"delete":{"tags":["NPN Management"],"x-internal":false,"x-audience":["customer"],"operationId":"deleteActiveNpns","summary":"Remove active NPNs subscribed to the account","description":"Request a list of currently active NPNs to un-associated with the account (or delete).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["912484758","123456689","999999999"]}}},"responses":{"202":{"description":"Accepted"},"401":{"$ref":"#/components/responses/401Unauthorized"},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"about:blank"},"status":{"type":"integer","example":415},"detail":{"type":"string","example":"Content-Type 'null' is not supported"},"instance":{"type":"string","example":"/v1/accounts/subscriptions"}}}}}},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/accounts/subscriptions/status/{jobId}":{"get":{"tags":["NPN Management"],"x-internal":false,"x-audience":["customer"],"operationId":"getNpnManagementJobStatus","summary":"Get the status for an NPN management job","description":"Returns the status and additional metadata about a specific NPN management job\n","parameters":[{"name":"jobId","in":"path","description":"ID of the job corresponding to the details you are looking for","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"0ded8367-01ac-4519-8cd7-ce965d55c0b0"},"createdAt":{"type":"string","format":"date","example":"2025-04-14","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2025-04-14","description":"Date of the most recent update to this record in AgentSync."},"details":{"type":"object","properties":{"success":{"type":"boolean","example":true},"state":{"type":"string","enum":["SUCCEEDED","FAILED"],"description":"Status of job - `SUCCEEDED`, `FAILED`"},"totalNpns":{"type":"integer","example":3},"queuedNpns":{"type":"integer","example":0},"inProgressNpns":{"type":"integer","example":0},"successfulNpns":{"type":"integer","example":3},"failedNpns":{"type":"integer","example":0}}},"links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0"}}},"details":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0/details"}}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/accounts/subscriptions/status/{jobId}/details":{"get":{"tags":["NPN Management"],"x-internal":false,"x-audience":["customer"],"operationId":"getNpnManagementJobStatusDetails","summary":"Get the status details for an NPN management job","description":"Returns the status details about a specific NPN management job\n","parameters":[{"name":"jobId","in":"path","description":"ID of the job corresponding to the details you are looking for","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"subscriptionJobItem":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILED"],"example":"FAILED","description":"Status of NPN in a job - `SUCCESS`, `FAILED`"},"npn":{"type":"string","example":229777},"message":{"type":"string","example":"No producer data found for entity id '{npn}'.","description":"Reason for failure (not present on success)"}}}}}},"links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0/details?page=0&size=250"}}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/addresses":{"get":{"tags":["Producer Addresses"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getAddresses","summary":"Get addresses for subscribed NPNs","description":"Returns all address records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all addresses\nfor all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one\nparameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/addresses":{"get":{"tags":["Producer Addresses"],"x-internal":false,"x-audience":["customer"],"operationId":"getAddressesByNPN","summary":"Get addresses for a specific NPN","description":"Returns all addresses associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/addresses/{id}":{"get":{"tags":["Producer Addresses"],"x-internal":false,"x-audience":["customer"],"operationId":"getAddressById","summary":"Get address by ID","description":"Retrieves a single address record using its unique address ID.\n","parameters":[{"name":"id","in":"path","description":"Unique address ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AddressV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/appointments":{"get":{"tags":["Producer Appointments"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getAppointments","summary":"Get appointments for subscribed NPNs","description":"Returns all appointment records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all appointments\nfor all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one\nparameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/coCodesParam"},{"$ref":"#/components/parameters/statusParam"},{"$ref":"#/components/parameters/loaCategoriesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"appointments":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentsV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/appointments":{"get":{"tags":["Producer Appointments"],"x-internal":false,"x-audience":["customer"],"operationId":"getAppointmentsByNPN","summary":"Get appointments for a specific NPN","description":"Returns all appointments associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/coCodesParam"},{"$ref":"#/components/parameters/statusParam"},{"$ref":"#/components/parameters/loaCategoriesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"appointments":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentsV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/appointments/{id}":{"get":{"tags":["Producer Appointments"],"x-internal":false,"x-audience":["customer"],"operationId":"getAppointmentById","summary":"Get appointment by ID","description":"Retrieves a single appointment record using its unique address ID.\n","parameters":[{"name":"id","in":"path","description":"Unique appointment ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AppointmentsV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/contactInfos":{"get":{"tags":["Producer Contact Information"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getContactInfos","summary":"Get contact information for subscribed NPNs","description":"Returns all contact information records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all contact\ninformation for all currently subscribed NPNs. To maximize effectiveness, we strongly\nrecommend using at least one parameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"contactInfos":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfosV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/contactInfos":{"get":{"tags":["Producer Contact Information"],"x-internal":false,"x-audience":["customer"],"operationId":"getContactInfosByNPN","summary":"Get contact information for a specific NPN","description":"Returns all contact information associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"contactInfos":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfosV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/contactInfos/{id}":{"get":{"tags":["Producer Contact Information"],"x-internal":false,"x-audience":["customer"],"operationId":"getContactInfoById","summary":"Get contact information by ID","description":"Retrieves a single contact information record using its unique contact information ID.\n","parameters":[{"name":"id","in":"path","description":"Unique contact information ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/ContactInfosV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities":{"get":{"tags":["Producer Entities"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getEntities","summary":"Get entities for subscribed NPNs","description":"Returns all entity records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all entities\nfor all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one\nparameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntitiesV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/entities/{npn}":{"get":{"tags":["Producer Entities"],"x-internal":false,"x-audience":["customer"],"operationId":"getEntitiesByNPN","summary":"Get the entity for a specific NPN","description":"Returns the entity associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntitiesV1"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/licenses":{"get":{"tags":["Producer Licenses and LOAs"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getLicenses","summary":"Get licenses for subscribed NPNs","description":"Returns all license records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all licenses\nfor all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one\nparameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/activeParam"},{"$ref":"#/components/parameters/loaCodesParam"},{"$ref":"#/components/parameters/loaCategoriesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicensesV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/licenseLoas":{"get":{"tags":["Producer Licenses and LOAs"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getLicenseLoas","summary":"Get license line of authorities (LOAs) for subscribed NPNs","description":"Returns all license LOA records for NPNs you are **currently subscribed** to\n","parameters":[{"$ref":"#/components/parameters/licenseIdsParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"embedded":{"$ref":"#/components/schemas/LicenseLoaV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/licenses/{licenseId}/licenseLoas":{"get":{"tags":["Producer Licenses and LOAs"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getLicenseLoasByLicenseId","summary":"Get license line of authorities for an associated license","description":"Returns all license line of authorities associated with a unique license ID\n","parameters":[{"$ref":"#/components/parameters/licenseIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"$ref":"#/components/schemas/LicenseLoaV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/licenses":{"get":{"tags":["Producer Licenses and LOAs"],"x-internal":false,"x-audience":["customer"],"operationId":"getLicensesByNpn","summary":"Get license for a specific NPN","description":"Returns all licenses associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/activeParam"},{"$ref":"#/components/parameters/loaCodesParam"},{"$ref":"#/components/parameters/loaCategoriesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicensesV2Response"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/licenses/{id}":{"get":{"tags":["Producer Licenses and LOAs"],"x-internal":false,"x-audience":["customer"],"operationId":"getLicenseById","summary":"Get licenses by ID","description":"Retrieves a single license record using its unique license ID.\n","parameters":[{"name":"id","in":"path","description":"Unique license ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/LicensesV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/licenseLoas/{id}":{"get":{"tags":["Producer Licenses and LOAs"],"x-internal":false,"x-audience":["customer"],"operationId":"getLicenseLoaById","summary":"Get license line of authority by ID","description":"Retrieves a single line of authority record using its unique loa ID.\n","parameters":[{"name":"id","in":"path","description":"Unique line of authority ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/LicenseLoaV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/otherNames":{"get":{"tags":["Producer Other Names"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getOtherNamesForSubscribedNpns","summary":"Get other names for subscribed NPNs","description":"Returns all other names records for NPNs you are **currently subscribed** to.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"otherNames":{"type":"array","items":{"$ref":"#/components/schemas/OtherNamesV2"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/otherNames":{"get":{"tags":["Producer Other Names"],"x-internal":false,"x-audience":["customer"],"operationId":"getOtherNamesForSpecificNpn","summary":"Get other names for a specific NPN","description":"Returns all other names associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"requestBody":{"description":"Request body to filter other names results.","content":{}},"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"otherNames":{"type":"array","items":{"$ref":"#/components/schemas/OtherNamesV2"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/otherNames/{id}":{"get":{"tags":["Producer Other Names"],"x-internal":false,"x-audience":["customer"],"operationId":"getOtherNameByIdV1","summary":"Get other names by ID","description":"Retrieves a single other names record using its unique other names ID.\n","parameters":[{"name":"id","in":"path","description":"Unique other names ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/OtherNamesV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/regulatoryActions":{"get":{"tags":["Producer Regulatory Actions"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getRegulatoryActionsForSubscribedNpns","summary":"Get regulatory actions for subscribed NPNs","description":"Returns all regulatory actions records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all\nregulatory actions for all currently subscribed NPNs. To maximize effectiveness, we strongly\nrecommend using at least one parameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"regulatoryActions":{"type":"array","items":{"$ref":"#/components/schemas/RegulatoryActionsV2"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/regulatoryActions/{id}/regulatoryActionValues":{"get":{"tags":["Producer Regulatory Actions"],"x-internal":false,"x-audience":["customer","prospect"],"operationId":"getRegulatoryActionValues","summary":"Get regulatory action values for a specific regulatory action","description":"Returns all regulatory actions value records for ID of a given regulatory action.\n","parameters":[{"name":"id","in":"path","description":"Unique regulatory actions ID","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"regulatoryActionValues":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/RegulatoryActionValuesV2"},{"type":"object"}]}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/regulatoryActions":{"get":{"tags":["Producer Regulatory Actions"],"x-internal":false,"x-audience":["customer"],"operationId":"getRegulatoryActionsByNpn","summary":"Get regulatory actions for a specific NPN","description":"Returns all regulatory actions associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"regulatoryActions":{"type":"array","items":{"$ref":"#/components/schemas/RegulatoryActionsV2"}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/regulatoryActions/{id}":{"get":{"tags":["Producer Regulatory Actions"],"x-internal":false,"x-audience":["customer"],"operationId":"getRegulatoryActionsById","summary":"Get regulatory actions by ID","description":"Retrieves a single regulatory actions record using its unique regulatory actions ID.\n","parameters":[{"name":"id","in":"path","description":"Unique regulatory actions ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/RegulatoryActionsV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/regulatoryActionValues/{id}":{"get":{"tags":["Producer Regulatory Actions"],"x-internal":false,"x-audience":["customer"],"operationId":"getRegulatoryActionValuesById","summary":"Get regulatory action values by ID","description":"Retrieves a single regulatory action value record using its unique regulatory action value ID.\n","parameters":[{"name":"id","in":"path","description":"Unique regulatory action value ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/RegulatoryActionValuesV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}}},"components":{"schemas":{"Subscription200":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"Job is in progress"},"job_id":{"type":"string","example":"0ded8367-01ac-4519-8cd7-ce965d55c0b0"},"links":{"type":"object","properties":{"status":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0"}}}}}}},"AddressV2Response":{"allOf":[{"type":"object"}]},"AddressV1":{"allOf":[{"type":"object"}]},"AppointmentsV2Response":{"allOf":[{"type":"object"}]},"AppointmentsV1":{"allOf":[{"type":"object"}]},"ContactInfosV2Response":{"allOf":[{"type":"object"}]},"ContactInfosV1":{"allOf":[{"type":"object"}]},"EntitiesV2Response":{"allOf":[{"type":"object"}]},"EntitiesV1":{"allOf":[{"type":"object"}]},"LicenseLoaV2":{"type":"object","description":"Container for a list of license records in version 2","properties":{"licenseLoas":{"type":"array","description":"A list of license objects","items":{"allOf":[{"type":"object"}]}}}},"LicensesV2Response":{"allOf":[{"type":"object","properties":{"licenseLoas":{"type":"array","items":{"$ref":"#/components/schemas/LicenseLoaV2"}},"agentTypes":{"type":"array","items":{"type":"string","example":"Producer"}},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the license was marked deleted by NIPR."}}}]},"LicenseLoaV1":{"allOf":[{"type":"object"}]},"LicensesV1":{"allOf":[{"type":"object","properties":{"licenseLoas":{"type":"array","items":{"$ref":"#/components/schemas/LicenseLoaV1"}},"agentTypes":{"type":"array","items":{"type":"string","example":"Producer"}},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the license was marked deleted by NIPR."}}}]},"OtherNamesV2":{"allOf":[{"type":"object"}]},"OtherNamesV1":{"allOf":[{"type":"object"}]},"RegulatoryActionValuesV2":{"type":"object","properties":{"regulatoryActionValues":{"type":"array","items":{"allOf":[{"type":"object","properties":{"metadata":{"type":"object","properties":{"last_nipr_alert_update":{"type":"string","format":"date-time","example":"2024-01-20T10:54:35.30506+00:00"},"last_nipr_entity_update":{"type":"string","format":"date-time","example":"2024-04-16T22:58:09.398811+00:00"}}},"deleted":{"type":"boolean","example":true}}}]}}}},"RegulatoryActionsV2":{"allOf":[{"type":"object","properties":{"regulatoryActionValues":{"$ref":"#/components/schemas/RegulatoryActionValuesV2"},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the regulatory actions was marked deleted by NIPR."}}}]},"RegulatoryActionValuesV1":{"allOf":[{"type":"object","properties":{"metadata":{"type":"object","properties":{"last_nipr_alert_updated":{"type":"string"},"last_nipr_entity_update":{"type":"string"}}},"deleted":{"type":"boolean","example":true}}}]},"RegulatoryActionsV1":{"allOf":[{"type":"object","properties":{"regulatoryActionValues":{"$ref":"#/components/schemas/RegulatoryActionValuesV1"},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the regulatory actions was marked deleted by NIPR."}}}]}},"parameters":{"npnPathParam":{"name":"npn","in":"path","description":"National Producer Number (npn) of the data to return","required":true,"schema":{"type":"string","example":"123456789"}},"npnsParam":{"name":"npns","in":"query","description":"comma separated list of National Producer Numbers (NPNs)","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"example":["123456789","987654321"]},"statesParam":{"name":"states","in":"query","description":"comma separated list of states abbreviations (must be 2 characters) - this will filter on the `forState` field","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"example":["MO","CA","CO"]},"includeDeletedParam":{"name":"includeDeleted","in":"query","description":"specifiy whether or not deleted records should be included in the response - this will filter on the `niprDeleted` field","required":false,"schema":{"type":"boolean","default":true}},"loaCategoriesParam":{"name":"loaCategories","in":"query","description":"comma seperated list of loa categories - this will filter on the `loaMapping.categories` array (it will return all records containing at least one of the values passed)","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"example":["casualty","property"]},"updatedSinceParam":{"name":"updatedSince","in":"query","description":"limits results to those that have an updated date equivalent to or after to the date provided (YYYY-MM-DD) - this will filter on the `updatedAt` field","required":false,"schema":{"type":"string","format":"date","pattern":"yyyy-MM-dd","example":"2024-10-15"}},"sizeParam":{"name":"size","in":"query","description":"the number of objects on the page (min = 1 / max = 1,000)","required":false,"schema":{"type":"integer","format":"int64","default":250,"minimum":1,"maximum":1000}},"coCodesParam":{"name":"coCodes","in":"query","description":"comma separated list of company/co codes (must by 5 digits) - this will filter on the `coCode` field","required":false,"schema":{"type":"string","example":"24740,70408,21458"}},"statusParam":{"name":"status","in":"query","description":"A single appointment status to search for. This is an exact string match of either `TERMINATED` or `APPOINTED` - this will filter on the `status` field","required":false,"schema":{"type":"string","enum":["TERMINATED","APPOINTED"],"default":null,"example":"TERMINATED"}},"activeParam":{"name":"active","in":"query","description":"`true` or `false` indicating a search for active licenses (in its absence, both active and inactive licenses will be returned)\n","required":false,"schema":{"type":"boolean","example":false}},"loaCodesParam":{"name":"loaCodes","in":"query","description":"comma separated list of LOA codes to filter licenses. This will return all licenses that match at least one of the specified LOA codes.","required":false,"schema":{"type":"string","example":"12,3"}},"licenseIdsParam":{"name":"licenseIds","in":"query","description":"comma separated list of license IDs","required":false,"schema":{"type":"string","example":"10000,1000033,21733"}},"licenseIdPathParam":{"name":"licenseId","in":"path","description":"License ID of the data to return","required":true,"schema":{"type":"integer","example":1234567}}},"responses":{"400BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"integer","example":1742929112},"status":{"type":"integer","example":400},"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"Invalid parameter values provided - {parameter}:[{invalid values}]"},"path":{"type":"string","example":"{endpoint_path}"}}}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthorized"}}}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"integer","example":1742935636},"status":{"type":"integer","example":403},"path":{"type":"string","example":"{requested endpoint}"},"error":{"type":"string","example":"Forbidden"}}}}}},"404NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"integer","example":1742929112},"status":{"type":"integer","example":404},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"Error message describing what was not found"},"path":{"type":"string","example":"{requested endpoint}"}}}}}},"405MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"about:blank"},"status":{"type":"integer","example":405},"detail":{"type":"string","example":"Method 'PUT' is not supported."},"instance":{"type":"string","example":"{requested endpoint}"}}}}}},"429TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"API rate limit exceeded"}}}}}},"500InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"integer","example":1613510729601},"status":{"type":"integer","example":500},"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Error message describing why this was a server error."},"path":{"type":"string","example":"{requested endpoint}"}}}}}},"504GatewayTimeout":{"description":"Gateway Timeout"}},"headers":{"ratelimit-limit":{"description":"Maximum number of requests allowed in the current window","schema":{"type":"integer"}},"ratelimit-remaining":{"description":"Number of requests remaining in the current window","schema":{"type":"integer"}},"ratelimit-reset":{"description":"Time when the rate limit will reset","schema":{"type":"integer"}}}}}
```