Search
K
ProducerSync API

Get other names by ID

Retrieves a single other names record using its unique other names ID.

get
https://api.sandbox.agentsync.io/v1/otherNames/{id}

Path Parameters

idintegerrequired

Unique other names ID

Response

application/hal+json

Success

OtherNamesV1

OtherNamesV1object
get/v1/otherNames/{id}
 
application/hal+json

Producer Regulatory Actions

Regulatory actions information for producers

Get regulatory actions for subscribed NPNs

Returns all regulatory actions records for NPNs you are currently subscribed to.

If no query parameters are provided in the request, then the response will include all
regulatory actions 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/regulatoryActions

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

Success

embeddedobject
Show Child Parameters
get/v2/regulatoryActions
 
application/hal+json

Get regulatory action values for a specific regulatory action

Returns all regulatory actions value records for ID of a given regulatory action.

get
https://api.sandbox.agentsync.io/v2/regulatoryActions/{id}/regulatoryActionValues

Query Parameters

sizeinteger(int64)

the number of objects on the page (min = 1 / max = 1,000)

Default:250

>= 1<= 1000

Path Parameters

idintegerrequired

Unique regulatory actions ID

Response

application/hal+json

Success

embeddedobject
Show Child Parameters
get/v2/regulatoryActions/{id}/regulatoryActionValues
 
application/hal+json

Get regulatory actions for a specific NPN

Returns all regulatory actions 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}/regulatoryActions

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

Success

embeddedobject
Show Child Parameters
get/v2/entities/{npn}/regulatoryActions
 
application/hal+json