Searching Contacts

See this article for general API requirements.

Apiary Links

In order to pull contact data from VoterVoice, you will want to use the Search Contacts get. You can search by contact ID, email address, or the date last modified.

If you are looking for modifications, you can specify the source of the change to pare down your results. So if you are only interested in changes the users made themselves from the user site, you can include a parameter under the date modified for changedSource=UserSite. Other options for the changedSource are AdminSite, Api, and System.

Detailed Instructions

Headers

Every API call is going to require the same two headers:

• your encrypted API key as the authorization
• application/json as the content type

Search Contacts

Note that these calls can return both contacts (uploaded records) and users (registered records).

By ID

• Open a new GET and paste in the following URL: https://www.votervoice.net/api/contacts?association=YourAssociationIDNAME&contactId=TheContactsID 

• Hit send. The response should be a status of 200 OK and include the contact record information in JSON format.

By Email

• Open a new GET and paste in the following URL: https://www.votervoice.net/api/contacts?association=YourAssociationIDNAME&email=TheContact’sEmailAddress
  • Either a normally formatted email address ([e-mail]) or an encoded version of the email (jean.valjean%40fiscalnote.com) will work fine.

• Hit send. The response should be a status of 200 OK and include the contact record information in JSON format.

By Date Updated / Date Modified

• Open a new GET and paste in the following URL: https://www.votervoice.net/api/contacts?association=YourAssociationIDNAME&dateUpdated=>YYYY-MM-DDTHH:MM:SSZ 
  • If the data range is listed as 2021-10-01T00:00:01Z, your search will pull any and all records modified since October 1st, 2021 at midnight and 1 second GMT. 
  • See the Date Range Parameters information below for more detail on this.

• Optionally, you can also specify the source of the change to pare down your results. 
  • If you are only interested in changes the users made themselves from the user site, you can include a parameter under the date modified for changedSource=UserSite. 
  • Other options for the changedSource are AdminSite, Api, and System.
• A successful call will yield a status of “200 OK” and the body of the contact information in JSON format.

Date Range Parameters

• This requires a very specific format for the date that features two parts: date and time in the general format of “YYYY-MM-DD” and “THH:MM:SSZ”. This is an internationally standardized format called ISO 8601. 
  • Example: 2021-10-13T14:02:00Z is October 13th, 2021 at exactly 2:02 PM UTC.
  • The time portion is optional.
• That “Z” at the end stands for zulu and denotes UTC (universal time code). You can change that to something like “-5” to denote EST or “-6” for CST. 
• Remember to use 24 hour time, not 12 hour.
• You need to begin the date with an operator: 
  • equals (=)
  • greater than or equal to (=>)
  • less than or equal to (=<). 
• You can even combine multiple terms to limit both ends of a date range with something like &dateUpdated=>YYYY-MM-DDTHH:MM:SSZ&dateUpdated=<YYYY-MM-DDTHH:MM:SSZ

If you have questions concerning the API calls, please email your specific questions, including the curl and any errors to [e-mail] for a Support agent to review.