Search
K
ProducerSync API

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
 
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
 
application/hal+json

Get regulatory actions by ID

Retrieves a single regulatory actions record using its unique regulatory actions ID.

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

Path Parameters

idintegerrequired

Unique regulatory actions ID

Response

application/hal+json

Success

RegulatoryActionsV1

regulatoryActionValuesobject
Show Child Parameters
niprDeletedboolean

Indicates if the regulatory actions was marked deleted by NIPR.

 
application/hal+json

Get regulatory action values by ID

Retrieves a single regulatory action value record using its unique regulatory action value ID.

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

Path Parameters

idintegerrequired

Unique regulatory action value ID

Response

application/hal+json

Success

RegulatoryActionValuesV1

metadataobject
Show Child Parameters
deletedboolean

Example:true

 
application/hal+json

Subscription200

object
successboolean

Example:true

messagestring

Example:Job is in progress

job_idstring

Example:0ded8367-01ac-4519-8cd7-ce965d55c0b0

linksobject
Show Child Parameters
Example