jobIdstring(uuid)required
ID of the job corresponding to the details you are looking for
Get the status details for an NPN management job
Returns the status details about a specific NPN management job
get
https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/{jobId}/details
Path Parameters
Response
application/hal+json
Response
application/hal+json
Success
embeddedobject
Show Child Parameters
linksobject
Show Child Parameters
application/hal+json
Producer Addresses
Address information for producers
Get addresses for subscribed NPNs
Returns all address records for NPNs you are currently subscribed to.
If no query parameters are provided in the request, then the response will include all addresses
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/addresses
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
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 addresses for a specific NPN
Returns all addresses 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}/addresses
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
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 address by ID
Retrieves a single address record using its unique address ID.
get
https://api.sandbox.agentsync.io/v1/addresses/{id}
Path Parameters
idintegerrequired
Unique address ID
Response
application/hal+json
Response
application/hal+json
Success
AddressV1
AddressV1object
application/hal+json