array[string]
Remove active NPNs subscribed to the account
Request a list of currently active NPNs to un-associated with the account (or delete).
delete
https://api.sandbox.agentsync.io/v1/accounts/subscriptions
Body
application/json
Body
application/json
Response
Response
Accepted
delete/v1/accounts/subscriptions
Body
[
"912484758",
"123456689",
"999999999"
]
Get the status for an NPN management job
Returns the status and additional metadata about a specific NPN management job
get
https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/{jobId}
Path Parameters
jobIdstring(uuid)required
ID of the job corresponding to the details you are looking for
Response
application/hal+json
Response
application/hal+json
Success
idstring(uuid)
Example:0ded8367-01ac-4519-8cd7-ce965d55c0b0
createdAtstring(date)
Date of the creation of this record in AgentSync.
Example:2025-04-14
updatedAtstring(date)
Date of the most recent update to this record in AgentSync.
Example:2025-04-14
detailsobject
Show Child Parameters
linksobject
Show Child Parameters
get/v1/accounts/subscriptions/status/{jobId}
Path Parameters
application/hal+json
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
jobIdstring(uuid)required
ID of the job corresponding to the details you are looking for
Response
application/hal+json
Response
application/hal+json
Success
embeddedobject
Show Child Parameters
linksobject
Show Child Parameters
get/v1/accounts/subscriptions/status/{jobId}/details
Path 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
get/v2/addresses
Query Parameters
application/hal+json