The endpoint for actions taken by your Contacts through the Action Center(s).
The endpoint for actions taken by your Contacts through the Action Center(s).
action_center_id | integer <int64> The actioncentersettings with which this grassrootssupporteraction is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
amount | integer <int64> A nonnegative transaction account, in the smallest denomination, assummed to be USD cents NOTE: Parameter accepts additional qualifiers appended to the end: |
archived | boolean Whether the record has been soft-deleted or not. |
bulk_email_id | integer <int64> The bulkemail with which this grassrootssupporteraction is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
campaign_id | integer <int64> The campaign this supporter action is associated with NOTE: Parameter accepts additional qualifiers appended to the end: |
confirmed | boolean Whether or not the action has been confirmed in a campaign requiring approval |
created | string <date-time> When the record was originally created. NOTE: Parameter accepts additional qualifiers appended to the end: |
date | string <date-time> The date that the supporter action took place NOTE: Parameter accepts additional qualifiers appended to the end: |
from_grassroots | boolean Indicator if the action is inlvolved in grassroots. Holdover from Note model |
id | integer <int64> The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint. |
interaction_type | integer <int64> Interaction type for the action. Required for all actions to help build inlines NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name GrassrootsInteractionType, for an explanation of values. |
note_type | integer <int64> Note type for the action. Should all be interactions NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name NoteType, for an explanation of values. |
organization_id | integer <int64> The organization that the supporter action is taking an action for NOTE: Parameter accepts additional qualifiers appended to the end: |
payroll_frequency_type | integer <int64> Payroll frequency for payroll contributions NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name PayrollFrequencyType, for an explanation of values. |
person_id | integer <int64> The person who the message is targeted for NOTE: Parameter accepts additional qualifiers appended to the end: |
projects | Array of integers <int64> The projects this supporter action is associated with. It can be associated with multiple projects NOTE: Parameter accepts additional qualifiers appended to the end: |
social_media_type | integer <int64> The type of social media being shared on Shared campaigns NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name SocialMediaType, 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. |
submitting_org_name | string If this is a comment regulation campaign, this the name of the organization NOTE: Parameter accepts additional qualifiers appended to the end: |
supporter_id | integer <int64> The supporter who owns this supporter action NOTE: Parameter accepts additional qualifiers appended to the end: |
transaction_method_type | integer <int64> The Type of method - credit card, ach transfer, etc NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name TransactionMethodType, for an explanation of values. |
updated | string <date-time> When the record was most recently updated. NOTE: Parameter accepts additional qualifiers appended to the end: |
dehydrate_extra | 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. |
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). |
GrassrootsSupporterAction retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "action_center": "/api/actioncentersettings/1/",
- "amount": 0,
- "archived": true,
- "audit_trail": { },
- "bulk_email": "/api/bulkemail/1/",
- "cache_json": { },
- "call_duration": 0,
- "campaign": "/api/campaign/1/",
- "clicks": 0,
- "confirmed": true,
- "created": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "delivered": true,
- "delivered_timestamp": "2019-08-24T14:15:22Z",
- "delivery_id": "string",
- "failed_delivery": true,
- "first_open": "2019-08-24T14:15:22Z",
- "from_grassroots": true,
- "http_referer": "string",
- "humanized_text": "string",
- "id": 0,
- "interaction_type": 1,
- "link_dict": { },
- "message_status": 1,
- "note_type": 1,
- "num_attempts": 0,
- "opens": 0,
- "organization": "/api/organization/1/",
- "payroll_frequency_type": 1,
- "person": "/api/newperson/1/",
- "points_earned": 0,
- "projects": [
- "/api/project/1/"
], - "raw_content": "string",
- "regions": [
- 1
], - "resource_uri": "string",
- "searchable_date": "string",
- "social_media_type": 1,
- "source_type": 1,
- "subject": "string",
- "submitting_org_name": "string",
- "supporter": "/api/newsupporter/1/",
- "supporter_action_type": 1,
- "text": "string",
- "timestamp": { },
- "transaction_method_type": 1,
- "unique_identifier": "string",
- "updated": "2019-08-24T14:15:22Z",
- "utm_campaign": "string",
- "utm_content": "string",
- "utm_medium": "string",
- "utm_source": "string",
- "utm_term": "string"
}
The endpoint for actions taken by your Contacts through the Action Center(s).
GrassrootsSupporterAction retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "action_center": "/api/actioncentersettings/1/",
- "amount": 0,
- "archived": true,
- "audit_trail": { },
- "bulk_email": "/api/bulkemail/1/",
- "cache_json": { },
- "call_duration": 0,
- "campaign": "/api/campaign/1/",
- "clicks": 0,
- "confirmed": true,
- "created": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "delivered": true,
- "delivered_timestamp": "2019-08-24T14:15:22Z",
- "delivery_id": "string",
- "failed_delivery": true,
- "first_open": "2019-08-24T14:15:22Z",
- "from_grassroots": true,
- "http_referer": "string",
- "humanized_text": "string",
- "id": 0,
- "interaction_type": 1,
- "link_dict": { },
- "message_status": 1,
- "note_type": 1,
- "num_attempts": 0,
- "opens": 0,
- "organization": "/api/organization/1/",
- "payroll_frequency_type": 1,
- "person": "/api/newperson/1/",
- "points_earned": 0,
- "projects": [
- "/api/project/1/"
], - "raw_content": "string",
- "regions": [
- 1
], - "resource_uri": "string",
- "searchable_date": "string",
- "social_media_type": 1,
- "source_type": 1,
- "subject": "string",
- "submitting_org_name": "string",
- "supporter": "/api/newsupporter/1/",
- "supporter_action_type": 1,
- "text": "string",
- "timestamp": { },
- "transaction_method_type": 1,
- "unique_identifier": "string",
- "updated": "2019-08-24T14:15:22Z",
- "utm_campaign": "string",
- "utm_content": "string",
- "utm_medium": "string",
- "utm_source": "string",
- "utm_term": "string"
}
The endpoint for actions taken by your Contacts through the Action Center(s).
archived | boolean Whether the record has been soft-deleted or not. |
confirmed | boolean Whether or not the action has been confirmed in a campaign requiring approval |
date | string <date-time> The date that the supporter action took place |
person_id | string <{"id": QUORUM_ID}> The person who the message is targeted for |
points_earned | integer <int64> Amount of points a supporter earned from this action |
projects | Array of strings <{"id": QUORUM_ID}> The projects this supporter action is associated with. It can be associated with multiple projects |
supporter_id | string <{"id": QUORUM_ID}> The supporter who owns this supporter action |
text | string The text body of the message |
user_id | string <{"id": QUORUM_ID}> The user associated with the action |
GrassrootsSupporterAction retrieved successfully
improperly configured request
authorization failure
internal server error
{- "archived": true,
- "confirmed": true,
- "date": "2019-08-24T14:15:22Z",
- "person_id": "string",
- "points_earned": 0,
- "projects": [
- "string"
], - "supporter_id": "string",
- "text": "string",
- "user_id": "string"
}
{- "_extra": { },
- "action_center": "/api/actioncentersettings/1/",
- "amount": 0,
- "archived": true,
- "audit_trail": { },
- "bulk_email": "/api/bulkemail/1/",
- "cache_json": { },
- "call_duration": 0,
- "campaign": "/api/campaign/1/",
- "clicks": 0,
- "confirmed": true,
- "created": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "delivered": true,
- "delivered_timestamp": "2019-08-24T14:15:22Z",
- "delivery_id": "string",
- "failed_delivery": true,
- "first_open": "2019-08-24T14:15:22Z",
- "from_grassroots": true,
- "http_referer": "string",
- "humanized_text": "string",
- "id": 0,
- "interaction_type": 1,
- "link_dict": { },
- "message_status": 1,
- "note_type": 1,
- "num_attempts": 0,
- "opens": 0,
- "organization": "/api/organization/1/",
- "payroll_frequency_type": 1,
- "person": "/api/newperson/1/",
- "points_earned": 0,
- "projects": [
- "/api/project/1/"
], - "raw_content": "string",
- "regions": [
- 1
], - "resource_uri": "string",
- "searchable_date": "string",
- "social_media_type": 1,
- "source_type": 1,
- "subject": "string",
- "submitting_org_name": "string",
- "supporter": "/api/newsupporter/1/",
- "supporter_action_type": 1,
- "text": "string",
- "timestamp": { },
- "transaction_method_type": 1,
- "unique_identifier": "string",
- "updated": "2019-08-24T14:15:22Z",
- "utm_campaign": "string",
- "utm_content": "string",
- "utm_medium": "string",
- "utm_source": "string",
- "utm_term": "string"
}
The endpoint for actions taken by your Contacts through the Action Center(s).
archived | boolean Whether the record has been soft-deleted or not. |
confirmed | boolean Whether or not the action has been confirmed in a campaign requiring approval |
date | string <date-time> The date that the supporter action took place |
person_id | string <{"id": QUORUM_ID}> The person who the message is targeted for |
points_earned | integer <int64> Amount of points a supporter earned from this action |
projects | Array of strings <{"id": QUORUM_ID}> The projects this supporter action is associated with. It can be associated with multiple projects |
supporter_id | string <{"id": QUORUM_ID}> The supporter who owns this supporter action |
text | string The text body of the message |
user_id | string <{"id": QUORUM_ID}> The user associated with the action |
GrassrootsSupporterAction retrieved successfully
improperly configured request
authorization failure
internal server error
{- "archived": true,
- "confirmed": true,
- "date": "2019-08-24T14:15:22Z",
- "person_id": "string",
- "points_earned": 0,
- "projects": [
- "string"
], - "supporter_id": "string",
- "text": "string",
- "user_id": "string"
}
{- "_extra": { },
- "action_center": "/api/actioncentersettings/1/",
- "amount": 0,
- "archived": true,
- "audit_trail": { },
- "bulk_email": "/api/bulkemail/1/",
- "cache_json": { },
- "call_duration": 0,
- "campaign": "/api/campaign/1/",
- "clicks": 0,
- "confirmed": true,
- "created": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "delivered": true,
- "delivered_timestamp": "2019-08-24T14:15:22Z",
- "delivery_id": "string",
- "failed_delivery": true,
- "first_open": "2019-08-24T14:15:22Z",
- "from_grassroots": true,
- "http_referer": "string",
- "humanized_text": "string",
- "id": 0,
- "interaction_type": 1,
- "link_dict": { },
- "message_status": 1,
- "note_type": 1,
- "num_attempts": 0,
- "opens": 0,
- "organization": "/api/organization/1/",
- "payroll_frequency_type": 1,
- "person": "/api/newperson/1/",
- "points_earned": 0,
- "projects": [
- "/api/project/1/"
], - "raw_content": "string",
- "regions": [
- 1
], - "resource_uri": "string",
- "searchable_date": "string",
- "social_media_type": 1,
- "source_type": 1,
- "subject": "string",
- "submitting_org_name": "string",
- "supporter": "/api/newsupporter/1/",
- "supporter_action_type": 1,
- "text": "string",
- "timestamp": { },
- "transaction_method_type": 1,
- "unique_identifier": "string",
- "updated": "2019-08-24T14:15:22Z",
- "utm_campaign": "string",
- "utm_content": "string",
- "utm_medium": "string",
- "utm_source": "string",
- "utm_term": "string"
}