| address_geocoded | boolean |
| archived | boolean |
| congressional_district_id | integer <int64> The district with which this supporter is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| created | string <date-time> NOTE: Parameter accepts additional qualifiers appended to the end: |
string NOTE: Parameter accepts additional qualifiers appended to the end: | |
| id | integer <int64> Quorum ID (Primary Key) |
| is_collaborator_supporter | boolean NOTE: Parameter accepts additional qualifiers appended to the end: |
| is_grassroots_supporter | boolean NOTE: Parameter accepts additional qualifiers appended to the end: |
| is_stakeholder_supporter | boolean 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 NOTE: Parameter accepts additional qualifiers appended to the end: |
| pac_conditional_giving_level | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| postal_code | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| public_organization_id | integer <int64> The publicorganization with which this supporter is associated. 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> 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 with which this supporter is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| title | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| unique_identifier | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| unsubscribed_from_bulk_emails | boolean |
| updated | string <date-time> NOTE: Parameter accepts additional qualifiers appended to the end: |
| valid_email | boolean |
| dehydrate | Array of strings Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values. |
| 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": false,
- "birthdate": "2019-08-24T14:15:22Z",
- "bulk_email_unsubscribe_key": "",
- "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",
- "created_by": "/api/user/1/",
- "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"
], - "fax": "",
- "fb_id": 0,
- "firstname": "string",
- "formatted_primary_phone": "string",
- "formatted_secondary_phone": "string",
- "has_ever_received_email_dn": false,
- "has_participated_in_any_campaign_dn": false,
- "has_shared_campaign_on_social_dn": false,
- "http_referer": "string",
- "icon": "string",
- "id": 0,
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_collaborator_supporter": true,
- "is_grassroots_supporter": true,
- "is_recently_active_email_recipient": false,
- "is_stakeholder_supporter": true,
- "last_action_date": "2019-08-24T14:15:22Z",
- "last_activated_at": "2019-08-24T14:15:22Z",
- "last_kind_action": 0,
- "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",
- "num_actions": 0,
- "num_campaigns_interacted": 0,
- "occupation": "",
- "pac_charity_additional_info": "string",
- "pac_charity_address": "string",
- "pac_charity_anonymous": true,
- "pac_charity_ein": "string",
- "pac_charity_name": "string",
- "pac_charity_selection_date": "2019-08-24T14:15:22Z",
- "pac_conditional_giving_level": "",
- "pac_conditional_giving_level_deprecated": 0,
- "pac_eligibilities": [
- "/api/ledgersettings/1/"
], - "pac_hybrid_eligible": false,
- "pacc_individual_id": 0,
- "pacc_organization_id": 0,
- "pacc_version": 0,
- "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": false,
- "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": "",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": false,
- "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": false,
- "website": "string",
- "work_fax": "",
- "work_phone": "",
- "youtube_array": [
- "string"
]
}NewSupporter retrieved successfully
improperly configured request
authorization failure
internal server error
{- "address": "string",
- "alternate_address": "string",
- "archived": true,
- "created_by_id": "string",
- "email": "string",
- "employer": "string",
- "extension": "string",
- "facebook_array": [
- "string"
], - "firstname": "string",
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_collaborator_supporter": true,
- "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",
- "occupation": "string",
- "organization_id": "string",
- "pac_conditional_giving_level": "string",
- "pac_eligibilities": [
- "string"
], - "pac_hybrid_eligible": true,
- "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,
- "unsubscribed_from_texting": true,
- "youtube_array": [
- "string"
]
}{- "_extra": { },
- "activated": true,
- "active": true,
- "address": "string",
- "address_geocoded": true,
- "alert_cache": { },
- "alternate_address": "string",
- "archived": false,
- "birthdate": "2019-08-24T14:15:22Z",
- "bulk_email_unsubscribe_key": "",
- "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",
- "created_by": "/api/user/1/",
- "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"
], - "fax": "",
- "fb_id": 0,
- "firstname": "string",
- "formatted_primary_phone": "string",
- "formatted_secondary_phone": "string",
- "has_ever_received_email_dn": false,
- "has_participated_in_any_campaign_dn": false,
- "has_shared_campaign_on_social_dn": false,
- "http_referer": "string",
- "icon": "string",
- "id": 0,
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_collaborator_supporter": true,
- "is_grassroots_supporter": true,
- "is_recently_active_email_recipient": false,
- "is_stakeholder_supporter": true,
- "last_action_date": "2019-08-24T14:15:22Z",
- "last_activated_at": "2019-08-24T14:15:22Z",
- "last_kind_action": 0,
- "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",
- "num_actions": 0,
- "num_campaigns_interacted": 0,
- "occupation": "",
- "pac_charity_additional_info": "string",
- "pac_charity_address": "string",
- "pac_charity_anonymous": true,
- "pac_charity_ein": "string",
- "pac_charity_name": "string",
- "pac_charity_selection_date": "2019-08-24T14:15:22Z",
- "pac_conditional_giving_level": "",
- "pac_conditional_giving_level_deprecated": 0,
- "pac_eligibilities": [
- "/api/ledgersettings/1/"
], - "pac_hybrid_eligible": false,
- "pacc_individual_id": 0,
- "pacc_organization_id": 0,
- "pacc_version": 0,
- "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": false,
- "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": "",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": false,
- "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": false,
- "website": "string",
- "work_fax": "",
- "work_phone": "",
- "youtube_array": [
- "string"
]
}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": false,
- "birthdate": "2019-08-24T14:15:22Z",
- "bulk_email_unsubscribe_key": "",
- "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",
- "created_by": "/api/user/1/",
- "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"
], - "fax": "",
- "fb_id": 0,
- "firstname": "string",
- "formatted_primary_phone": "string",
- "formatted_secondary_phone": "string",
- "has_ever_received_email_dn": false,
- "has_participated_in_any_campaign_dn": false,
- "has_shared_campaign_on_social_dn": false,
- "http_referer": "string",
- "icon": "string",
- "id": 0,
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_collaborator_supporter": true,
- "is_grassroots_supporter": true,
- "is_recently_active_email_recipient": false,
- "is_stakeholder_supporter": true,
- "last_action_date": "2019-08-24T14:15:22Z",
- "last_activated_at": "2019-08-24T14:15:22Z",
- "last_kind_action": 0,
- "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",
- "num_actions": 0,
- "num_campaigns_interacted": 0,
- "occupation": "",
- "pac_charity_additional_info": "string",
- "pac_charity_address": "string",
- "pac_charity_anonymous": true,
- "pac_charity_ein": "string",
- "pac_charity_name": "string",
- "pac_charity_selection_date": "2019-08-24T14:15:22Z",
- "pac_conditional_giving_level": "",
- "pac_conditional_giving_level_deprecated": 0,
- "pac_eligibilities": [
- "/api/ledgersettings/1/"
], - "pac_hybrid_eligible": false,
- "pacc_individual_id": 0,
- "pacc_organization_id": 0,
- "pacc_version": 0,
- "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": false,
- "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": "",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": false,
- "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": false,
- "website": "string",
- "work_fax": "",
- "work_phone": "",
- "youtube_array": [
- "string"
]
}NewSupporter retrieved successfully
improperly configured request
authorization failure
internal server error
{- "address": "string",
- "alternate_address": "string",
- "archived": true,
- "created_by_id": "string",
- "email": "string",
- "employer": "string",
- "extension": "string",
- "facebook_array": [
- "string"
], - "firstname": "string",
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_collaborator_supporter": true,
- "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",
- "occupation": "string",
- "organization_id": "string",
- "pac_conditional_giving_level": "string",
- "pac_eligibilities": [
- "string"
], - "pac_hybrid_eligible": true,
- "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,
- "unsubscribed_from_texting": true,
- "youtube_array": [
- "string"
]
}{- "_extra": { },
- "activated": true,
- "active": true,
- "address": "string",
- "address_geocoded": true,
- "alert_cache": { },
- "alternate_address": "string",
- "archived": false,
- "birthdate": "2019-08-24T14:15:22Z",
- "bulk_email_unsubscribe_key": "",
- "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",
- "created_by": "/api/user/1/",
- "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"
], - "fax": "",
- "fb_id": 0,
- "firstname": "string",
- "formatted_primary_phone": "string",
- "formatted_secondary_phone": "string",
- "has_ever_received_email_dn": false,
- "has_participated_in_any_campaign_dn": false,
- "has_shared_campaign_on_social_dn": false,
- "http_referer": "string",
- "icon": "string",
- "id": 0,
- "image_url": "string",
- "input_address": "string",
- "instagram_array": [
- "string"
], - "is_collaborator_supporter": true,
- "is_grassroots_supporter": true,
- "is_recently_active_email_recipient": false,
- "is_stakeholder_supporter": true,
- "last_action_date": "2019-08-24T14:15:22Z",
- "last_activated_at": "2019-08-24T14:15:22Z",
- "last_kind_action": 0,
- "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",
- "num_actions": 0,
- "num_campaigns_interacted": 0,
- "occupation": "",
- "pac_charity_additional_info": "string",
- "pac_charity_address": "string",
- "pac_charity_anonymous": true,
- "pac_charity_ein": "string",
- "pac_charity_name": "string",
- "pac_charity_selection_date": "2019-08-24T14:15:22Z",
- "pac_conditional_giving_level": "",
- "pac_conditional_giving_level_deprecated": 0,
- "pac_eligibilities": [
- "/api/ledgersettings/1/"
], - "pac_hybrid_eligible": false,
- "pacc_individual_id": 0,
- "pacc_organization_id": 0,
- "pacc_version": 0,
- "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": false,
- "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": "",
- "twitter_array": [
- "string"
], - "unique_identifier": "string",
- "unsubscribed_from_bulk_emails": false,
- "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": false,
- "website": "string",
- "work_fax": "",
- "work_phone": "",
- "youtube_array": [
- "string"
]
}