idintegerrequired
Unique address ID
Get address by ID
Retrieves a single address record using its unique address ID.
get
https://api.sandbox.agentsync.io/v1/addresses/{id}
Path Parameters
Response
application/hal+json
Response
application/hal+json
Success
AddressV1
AddressV1object
application/hal+json
Producer Appointments
Appointment information for producers
Get appointments for subscribed NPNs
Returns all appointment records for NPNs you are currently subscribed to.
If no query parameters are provided in the request, then the response will include all appointments
for all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one
parameter to narrow your results.
get
https://api.sandbox.agentsync.io/v2/appointments
Query Parameters
npnsarray[string]
comma separated list of National Producer Numbers (NPNs)
Example:123456789, 987654321
statesarray[string]
comma separated list of states abbreviations (must be 2 characters) - this will filter on the forState field
Example:MO, CA, CO
coCodesstring
comma separated list of company/co codes (must by 5 digits) - this will filter on the coCode field
Example:24740,70408,21458
statusstring
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
Allowed values:TERMINATEDAPPOINTED
Default:null
Example:TERMINATED
loaCategoriesarray[string]
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)
Example:casualty, property
updatedSincestring(date)
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
Match pattern:yyyy-MM-dd
Example:2024-10-15
includeDeletedboolean
specifiy whether or not deleted records should be included in the response - this will filter on the niprDeleted field
Default:true
sizeinteger(int64)
the number of objects on the page (min = 1 / max = 1,000)
Default:250
>= 1<= 1000
Response
application/hal+json
Response
application/hal+json
Success
embeddedobject
Show Child Parameters
application/hal+json
Get appointments for a specific NPN
Returns all appointments associated with a specific NPN. If you’re not already subscribed, this request will automatically subscribe you to the NPN.
get
https://api.sandbox.agentsync.io/v2/entities/{npn}/appointments
Query Parameters
statesarray[string]
comma separated list of states abbreviations (must be 2 characters) - this will filter on the forState field
Example:MO, CA, CO
coCodesstring
comma separated list of company/co codes (must by 5 digits) - this will filter on the coCode field
Example:24740,70408,21458
statusstring
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
Allowed values:TERMINATEDAPPOINTED
Default:null
Example:TERMINATED
loaCategoriesarray[string]
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)
Example:casualty, property
updatedSincestring(date)
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
Match pattern:yyyy-MM-dd
Example:2024-10-15
includeDeletedboolean
specifiy whether or not deleted records should be included in the response - this will filter on the niprDeleted field
Default:true
sizeinteger(int64)
the number of objects on the page (min = 1 / max = 1,000)
Default:250
>= 1<= 1000
Path Parameters
npnstringrequired
National Producer Number (npn) of the data to return
Example:123456789
Response
application/hal+json
Response
application/hal+json
Success
embeddedobject
Show Child Parameters
application/hal+json
Get appointment by ID
Retrieves a single appointment record using its unique address ID.
get
https://api.sandbox.agentsync.io/v1/appointments/{id}
Path Parameters
idintegerrequired
Unique appointment ID
Response
application/hal+json
Response
application/hal+json
Success
AppointmentsV1
AppointmentsV1object
application/hal+json