The endpoint for the Contacts dataset.
Sample queries:
www.quorum.us/api/newsupporter/12345/?username=[USERNAME]&api_key=[API_KEY]
www.quorum.us/api/newsupporter/?firstname__iexact=john&username=[USERNAME]&api_key=[API_KEY]
www.quorum.us/api/newsupporter/?email__icontains=gmail.com&?username=[USERNAME]&api_key=[API_KEY]
address_geocoded | boolean Whether the string address has been geocoded into lat/lon pair. |
archived | boolean Whether the record has been soft-deleted or not. |
congressional_district_id | integer <int64> The district object for the U.S. House of Representatives district within which thisContact's geocoded primary address is located. NOTE: Parameter accepts additional qualifiers appended to the end: |
created | string <date-time> When the record was originally created. NOTE: Parameter accepts additional qualifiers appended to the end: |
string Primary Email Address for this Contact; this is the address available in Outbox to email this Contact. NOTE: Parameter accepts additional qualifiers appended to the end: | |
id | integer <int64> The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint. |
is_grassroots_supporter | boolean Whether this contact is someone who would advocate on your behalf (for User information, does not impact Quorum application) NOTE: Parameter accepts additional qualifiers appended to the end: |
is_stakeholder_supporter | boolean Whether this contact is an influencer for your organization's public policy objectives. (for User information, does not impact Quorum application) NOTE: Parameter accepts additional qualifiers appended to the end: |
members | Array of integers <int64> The newpersons that are associated with this supporter. NOTE: Parameter accepts additional qualifiers appended to the end: |
name | string Full Name NOTE: Parameter accepts additional qualifiers appended to the end: |
postal_code | string Postal code of primary address. NOTE: Parameter accepts additional qualifiers appended to the end: |
public_organization_id | integer <int64> The organization associated with the Supporter. NOTE: Parameter accepts additional qualifiers appended to the end: |
region | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name Region, for an explanation of values. |
source_type | integer <int64> Our best guess as to the source of a particular thing, whether internal to Quorum, a particular website, etc. NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name UTMSourceType, for an explanation of values. |
state_id | integer <int64> The State object in the Geography model for this Contact's Geocoded primary address. NOTE: Parameter accepts additional qualifiers appended to the end: |
title | string Title. NOTE: Parameter accepts additional qualifiers appended to the end: |
unsubscribed_from_bulk_emails | boolean Whether the contact is unsubscribed from your bulk emails. |
updated | string <date-time> When the record was most recently updated. NOTE: Parameter accepts additional qualifiers appended to the end: |
valid_email | boolean When a contact is initially created in Quorum, the default value of "valid_email" is True. Accordingly, a better way to think about this field might be to invert it -- think of it as "invalid_email" where it would be initialized as false. Upon initial save of a contact object, we run a basic pattern match on the email to see if it matches the RFC standard for emails: '([a-zA-Z0-9_.+-']+@(?:[a-zA-Z0-9_-]+.)+[a-zA-Z0-9_-.]+)$'. In plain English, this means that any set of letters, numbers, dots, plus signs, and dashes followed by an @ sign and then a valid domain is permissible. If an email fails this test, the contact is immediately set to valid_email=False. Blank or null strings do not currently fail this test as our sending logic requires both the presence of a not-null not-empty email and valid_email being set to True. Once we send an email to this contact, we start receiving responses from that recipient's email server and use those responses to determine if an email should be set to invalid -- this is the primary reason why that might occur. Generally, sending multiple emails to a bad, old, or fake email is one of the easiest ways to get added to email block lists and hurt your overall domain reputation, so we follow email sending best practices and set this field to false anytime we receive a hard block or spam block from this email. To classify actions, we use the fields provided by our email partner, Sparkpost, available here: https://www.sparkpost.com/docs/deliverability/bounce-classification-codes/. If an email receives a bounce event in the classification "Hard", "Block", or "Admin", we will set valid_email to false and not email it again. Should you wish to "reset" this field, you can either use Bulk Actions through the UI or a bulk upload to reset this field and try to email it again via Outbox. If we receive a further hard bounce from this email, we'll re-mark it as invalid; however, if your email is successfully delivered, you'll be able to continue emailing this person until you get another hard block of some kind. |
advanced_search | string Perform an advanced text search on the datset with the provided text. This search will use the most comprehensive search method available on the requested endpoint, but can take slightly longer to return results. |
quick_search | string Perform an quick text search on the datset with the provided text. This search method may, depending on the endpoint, be exactly identical to advanced search, or may return results significantly more quickly but with less completeness or accuracy, for example by searching less fields, or using a faster algorithm to identify matches that has a greater propensity for false positives/false negatives. |
limit | integer <int64> Default: 20 The number of records to return (for pagination). |
offset | integer <int64> Default: 0 The number of records to offset the start of the data being returned (for pagination). |
NewSupporter retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "activated": true,
- "active": true,
- "address": "string",
- "address_geocoded": true,
- "alert_cache": { },
- "alternate_address": "string",
- "archived": true,
- "birthdate": "2019-08-24T14:15:22Z",
- "bulk_email_unsubscribe_key": "string",
- "cached_limited_to_teams": null,
- "calculated_unsubscribed_from_texting": 0,
- "city": "string",
- "coordinates": "string",
- "country_name": "string",
- "county_name": "string",
- "created": "2019-08-24T14:15:22Z",
- "date_unsubscribed_from_bulk_emails": "2019-08-24T14:15:22Z",
- "date_unsubscribed_from_texting": "2019-08-24T14:15:22Z",
- "email": "string",
- "email_related_person": "/api/newperson/1/",
- "employer": "string",
- "extension": "string",
- "facebook_array": [
- "string"
], - "facebook_url_array": [
- "string"
], - "fb_id": 0,
- "firstname": "string",
- "formatted_primary_phone": "string",
- "formatted_secondary_phone": "string",
- "has_ever_received_email_dn": true,
- "has_participated_in_any_campaign_dn": true,
- "has_shared_campaign_on_social_dn": true,
- "http_referer": "string",
- "icon": "string",
- "id": 0,
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_grassroots_supporter": true,
- "is_recently_active_email_recipient": true,
- "is_stakeholder_supporter": true,
- "last_user": "/api/user/1/",
- "lastname": "string",
- "latitude": 0,
- "limited_to_teams": [
- "/api/team/1/"
], - "longitude": 0,
- "major_organization_types": null,
- "medium_array": [
- "string"
], - "middlename": "string",
- "name": "string",
- "pac_eligibilities": [
- "/api/ledgersettings/1/"
], - "phone_number": "string",
- "postal_code": "string",
- "postal_code_ext": "string",
- "preferred_name": "string",
- "prefix": "string",
- "public_organization": "/api/publicorganization/1/",
- "public_organization_name": "string",
- "public_organization_names": "string",
- "public_organizations": [
- "/api/publicorganization/1/"
], - "region": 1,
- "registered_with_text_keyword": "string",
- "resource_uri": "string",
- "secondary_email": "string",
- "secondary_extension": "string",
- "secondary_phone": "string",
- "should_display_in_external_logger": true,
- "source_type": 1,
- "state_abbreviation": "string",
- "state_name": "string",
- "street_address": "string",
- "street_address_2": "string",
- "stripe_customer_id": "string",
- "suffix": "string",
- "supporter_type": 1,
- "tag_dict": { },
- "title": "string",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": true,
- "unsubscribed_from_texting": true,
- "updated": "2019-08-24T14:15:22Z",
- "user": "/api/user/1/",
- "utm_campaign": "string",
- "utm_content": "string",
- "utm_medium": "string",
- "utm_source": "string",
- "utm_term": "string",
- "valid_email": true,
- "validated_address": true,
- "waiting_to_be_created_by_user": true,
- "website": "string",
- "youtube_array": [
- "string"
]
}
The endpoint for the Contacts dataset.
NewSupporter retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "activated": true,
- "active": true,
- "address": "string",
- "address_geocoded": true,
- "alert_cache": { },
- "alternate_address": "string",
- "archived": true,
- "birthdate": "2019-08-24T14:15:22Z",
- "bulk_email_unsubscribe_key": "string",
- "cached_limited_to_teams": null,
- "calculated_unsubscribed_from_texting": 0,
- "city": "string",
- "coordinates": "string",
- "country_name": "string",
- "county_name": "string",
- "created": "2019-08-24T14:15:22Z",
- "date_unsubscribed_from_bulk_emails": "2019-08-24T14:15:22Z",
- "date_unsubscribed_from_texting": "2019-08-24T14:15:22Z",
- "email": "string",
- "email_related_person": "/api/newperson/1/",
- "employer": "string",
- "extension": "string",
- "facebook_array": [
- "string"
], - "facebook_url_array": [
- "string"
], - "fb_id": 0,
- "firstname": "string",
- "formatted_primary_phone": "string",
- "formatted_secondary_phone": "string",
- "has_ever_received_email_dn": true,
- "has_participated_in_any_campaign_dn": true,
- "has_shared_campaign_on_social_dn": true,
- "http_referer": "string",
- "icon": "string",
- "id": 0,
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_grassroots_supporter": true,
- "is_recently_active_email_recipient": true,
- "is_stakeholder_supporter": true,
- "last_user": "/api/user/1/",
- "lastname": "string",
- "latitude": 0,
- "limited_to_teams": [
- "/api/team/1/"
], - "longitude": 0,
- "major_organization_types": null,
- "medium_array": [
- "string"
], - "middlename": "string",
- "name": "string",
- "pac_eligibilities": [
- "/api/ledgersettings/1/"
], - "phone_number": "string",
- "postal_code": "string",
- "postal_code_ext": "string",
- "preferred_name": "string",
- "prefix": "string",
- "public_organization": "/api/publicorganization/1/",
- "public_organization_name": "string",
- "public_organization_names": "string",
- "public_organizations": [
- "/api/publicorganization/1/"
], - "region": 1,
- "registered_with_text_keyword": "string",
- "resource_uri": "string",
- "secondary_email": "string",
- "secondary_extension": "string",
- "secondary_phone": "string",
- "should_display_in_external_logger": true,
- "source_type": 1,
- "state_abbreviation": "string",
- "state_name": "string",
- "street_address": "string",
- "street_address_2": "string",
- "stripe_customer_id": "string",
- "suffix": "string",
- "supporter_type": 1,
- "tag_dict": { },
- "title": "string",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": true,
- "unsubscribed_from_texting": true,
- "updated": "2019-08-24T14:15:22Z",
- "user": "/api/user/1/",
- "utm_campaign": "string",
- "utm_content": "string",
- "utm_medium": "string",
- "utm_source": "string",
- "utm_term": "string",
- "valid_email": true,
- "validated_address": true,
- "waiting_to_be_created_by_user": true,
- "website": "string",
- "youtube_array": [
- "string"
]
}
The endpoint for the Contacts dataset.
NewSupporter retrieved successfully
improperly configured request
authorization failure
internal server error
{- "address": "string",
- "alternate_address": "string",
- "archived": true,
- "email": "string",
- "employer": "string",
- "extension": "string",
- "facebook_array": [
- "string"
], - "firstname": "string",
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_grassroots_supporter": true,
- "is_stakeholder_supporter": true,
- "last_user_id": "string",
- "lastname": "string",
- "limited_to_teams": [
- "string"
], - "medium_array": [
- "string"
], - "middlename": "string",
- "name": "string",
- "organization_id": "string",
- "pac_eligibilities": [
- "string"
], - "phone_number": "string",
- "preferred_name": "string",
- "prefix": "string",
- "public_organization_id": "string",
- "public_organizations": [
- "string"
], - "secondary_email": "string",
- "secondary_extension": "string",
- "secondary_phone": "string",
- "should_display_in_external_logger": true,
- "suffix": "string",
- "tag_dict": "string",
- "title": "string",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": true,
- "youtube_array": [
- "string"
]
}
{- "_extra": { },
- "activated": true,
- "active": true,
- "address": "string",
- "address_geocoded": true,
- "alert_cache": { },
- "alternate_address": "string",
- "archived": true,
- "birthdate": "2019-08-24T14:15:22Z",
- "bulk_email_unsubscribe_key": "string",
- "cached_limited_to_teams": null,
- "calculated_unsubscribed_from_texting": 0,
- "city": "string",
- "coordinates": "string",
- "country_name": "string",
- "county_name": "string",
- "created": "2019-08-24T14:15:22Z",
- "date_unsubscribed_from_bulk_emails": "2019-08-24T14:15:22Z",
- "date_unsubscribed_from_texting": "2019-08-24T14:15:22Z",
- "email": "string",
- "email_related_person": "/api/newperson/1/",
- "employer": "string",
- "extension": "string",
- "facebook_array": [
- "string"
], - "facebook_url_array": [
- "string"
], - "fb_id": 0,
- "firstname": "string",
- "formatted_primary_phone": "string",
- "formatted_secondary_phone": "string",
- "has_ever_received_email_dn": true,
- "has_participated_in_any_campaign_dn": true,
- "has_shared_campaign_on_social_dn": true,
- "http_referer": "string",
- "icon": "string",
- "id": 0,
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_grassroots_supporter": true,
- "is_recently_active_email_recipient": true,
- "is_stakeholder_supporter": true,
- "last_user": "/api/user/1/",
- "lastname": "string",
- "latitude": 0,
- "limited_to_teams": [
- "/api/team/1/"
], - "longitude": 0,
- "major_organization_types": null,
- "medium_array": [
- "string"
], - "middlename": "string",
- "name": "string",
- "pac_eligibilities": [
- "/api/ledgersettings/1/"
], - "phone_number": "string",
- "postal_code": "string",
- "postal_code_ext": "string",
- "preferred_name": "string",
- "prefix": "string",
- "public_organization": "/api/publicorganization/1/",
- "public_organization_name": "string",
- "public_organization_names": "string",
- "public_organizations": [
- "/api/publicorganization/1/"
], - "region": 1,
- "registered_with_text_keyword": "string",
- "resource_uri": "string",
- "secondary_email": "string",
- "secondary_extension": "string",
- "secondary_phone": "string",
- "should_display_in_external_logger": true,
- "source_type": 1,
- "state_abbreviation": "string",
- "state_name": "string",
- "street_address": "string",
- "street_address_2": "string",
- "stripe_customer_id": "string",
- "suffix": "string",
- "supporter_type": 1,
- "tag_dict": { },
- "title": "string",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": true,
- "unsubscribed_from_texting": true,
- "updated": "2019-08-24T14:15:22Z",
- "user": "/api/user/1/",
- "utm_campaign": "string",
- "utm_content": "string",
- "utm_medium": "string",
- "utm_source": "string",
- "utm_term": "string",
- "valid_email": true,
- "validated_address": true,
- "waiting_to_be_created_by_user": true,
- "website": "string",
- "youtube_array": [
- "string"
]
}
The endpoint for the Contacts dataset.
NewSupporter retrieved successfully
improperly configured request
authorization failure
internal server error
{- "address": "string",
- "alternate_address": "string",
- "archived": true,
- "email": "string",
- "employer": "string",
- "extension": "string",
- "facebook_array": [
- "string"
], - "firstname": "string",
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_grassroots_supporter": true,
- "is_stakeholder_supporter": true,
- "last_user_id": "string",
- "lastname": "string",
- "limited_to_teams": [
- "string"
], - "medium_array": [
- "string"
], - "middlename": "string",
- "name": "string",
- "organization_id": "string",
- "pac_eligibilities": [
- "string"
], - "phone_number": "string",
- "preferred_name": "string",
- "prefix": "string",
- "public_organization_id": "string",
- "public_organizations": [
- "string"
], - "secondary_email": "string",
- "secondary_extension": "string",
- "secondary_phone": "string",
- "should_display_in_external_logger": true,
- "suffix": "string",
- "tag_dict": "string",
- "title": "string",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": true,
- "youtube_array": [
- "string"
]
}
{- "_extra": { },
- "activated": true,
- "active": true,
- "address": "string",
- "address_geocoded": true,
- "alert_cache": { },
- "alternate_address": "string",
- "archived": true,
- "birthdate": "2019-08-24T14:15:22Z",
- "bulk_email_unsubscribe_key": "string",
- "cached_limited_to_teams": null,
- "calculated_unsubscribed_from_texting": 0,
- "city": "string",
- "coordinates": "string",
- "country_name": "string",
- "county_name": "string",
- "created": "2019-08-24T14:15:22Z",
- "date_unsubscribed_from_bulk_emails": "2019-08-24T14:15:22Z",
- "date_unsubscribed_from_texting": "2019-08-24T14:15:22Z",
- "email": "string",
- "email_related_person": "/api/newperson/1/",
- "employer": "string",
- "extension": "string",
- "facebook_array": [
- "string"
], - "facebook_url_array": [
- "string"
], - "fb_id": 0,
- "firstname": "string",
- "formatted_primary_phone": "string",
- "formatted_secondary_phone": "string",
- "has_ever_received_email_dn": true,
- "has_participated_in_any_campaign_dn": true,
- "has_shared_campaign_on_social_dn": true,
- "http_referer": "string",
- "icon": "string",
- "id": 0,
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_grassroots_supporter": true,
- "is_recently_active_email_recipient": true,
- "is_stakeholder_supporter": true,
- "last_user": "/api/user/1/",
- "lastname": "string",
- "latitude": 0,
- "limited_to_teams": [
- "/api/team/1/"
], - "longitude": 0,
- "major_organization_types": null,
- "medium_array": [
- "string"
], - "middlename": "string",
- "name": "string",
- "pac_eligibilities": [
- "/api/ledgersettings/1/"
], - "phone_number": "string",
- "postal_code": "string",
- "postal_code_ext": "string",
- "preferred_name": "string",
- "prefix": "string",
- "public_organization": "/api/publicorganization/1/",
- "public_organization_name": "string",
- "public_organization_names": "string",
- "public_organizations": [
- "/api/publicorganization/1/"
], - "region": 1,
- "registered_with_text_keyword": "string",
- "resource_uri": "string",
- "secondary_email": "string",
- "secondary_extension": "string",
- "secondary_phone": "string",
- "should_display_in_external_logger": true,
- "source_type": 1,
- "state_abbreviation": "string",
- "state_name": "string",
- "street_address": "string",
- "street_address_2": "string",
- "stripe_customer_id": "string",
- "suffix": "string",
- "supporter_type": 1,
- "tag_dict": { },
- "title": "string",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": true,
- "unsubscribed_from_texting": true,
- "updated": "2019-08-24T14:15:22Z",
- "user": "/api/user/1/",
- "utm_campaign": "string",
- "utm_content": "string",
- "utm_medium": "string",
- "utm_source": "string",
- "utm_term": "string",
- "valid_email": true,
- "validated_address": true,
- "waiting_to_be_created_by_user": true,
- "website": "string",
- "youtube_array": [
- "string"
]
}