idintegerrequired
Unique contact information ID
Get contact information by ID
Retrieves a single contact information record using its unique contact information ID.
get
https://api.sandbox.agentsync.io/v1/contactInfos/{id}
Path Parameters
Response
application/hal+json
Response
application/hal+json
Success
ContactInfosV1
ContactInfosV1object
get/v1/contactInfos/{id}
Path Parameters
application/hal+json
Producer Entities
Entity information for producers
Get entities for subscribed NPNs
Returns all entity records for NPNs you are currently subscribed to.
If no query parameters are provided in the request, then the response will include all entities
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/entities
Query Parameters
npnsarray[string]
comma separated list of National Producer Numbers (NPNs)
Example:123456789, 987654321
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/entities
Query Parameters
application/hal+json
Get the entity for a specific NPN
Returns the entity 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/v1/entities/{npn}
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
get/v1/entities/{npn}
Path Parameters
application/hal+json
Producer Licenses and LOAs
License and LOA information for producers