/getContributors
Updated
by
Jon Doehling
Get Contributors API Call
- Returns all contributors found for a particular event.
Production Endpoint: https://auctionconductor.com/API/getContributors
Test Endpoint: https://actestserver.com/API/getEventContributor
Accepted Data
Parameter | Req’d | Format | Default | Description |
event_id | Y | Number | (none) | Unique identifier for the event. Organization assigned to the event must match the API key. |
Return Values
Parameter | Value | Description |
contributor_id | number | Unique identifier for the contributor. |
event_contributor_id | number | Unique identifier for the contributor in relation to the event. |
contributor_types | string array | Contributor types for selected event contributor returned as array of string |
first_name | text | Contributor first name |
last_name | text | Contributor last name |
cell | text | Contributor cell phone |
text | Contributor email address | |
company | text | Contributor company name |
alternate_key | text | Contributor alternate identification key |
bidder_number | number | Event specific bidder number |
primary_contributor_id | number | Contributor id for the primary contributor in the association, if applicable |
address | text | Contributor mailing address line 1 |
address2 | text | Contributor mailing address line 2 |
city | text | Contributor mailing address city |
state | text | Contributor mailing address state |
zip | text | Contributor mailing address zip code |
country | text | Contributor mailing address country |
sms_opt_in | 10 chars | Event specific Opt-in setting for optional SMS text messaging alerts. |
notes_check_in | text | Event specific notes for check-in |
vip | boolean | Event specific VIP setting |
created_by | text | Possible responses include:
|
created_at | timestamp | Date and time of the original transaction |
last_edited_by | text | Possible responses include:
|
last_edited_at | timestamp | Date and time of the edited transaction |
group | text | The group name assigned by the ticket purchaser at checkout. |
email_opt | boolean | Indicates if the contributor has opted out of email communications for this event. |
checked_in | boolean | Indicates if the contributor has checked in to the event, either online via express check-in, or in-person. |
arrived | boolean | Indicates if the contributor has arrived the event, either via QR code scan, or manual lookup. |
bidding | boolean | Indicates if the contributor has placed any bids in the silent or live auctions. |
Sample Call
{
event_id: "2442"
}Sample Response
[
},
{
"contributor_id": 37788,
"event_contributor_id": 69751,
"contributor_types": [
"Sponsor",
"Volunteer"
],
"first_name": "John",
"last_name": "Barry",
"cell": null,
"email": "john@barryroofing.com",
"company": "Barry Roofing",
"alternate_key": null,
"bidder_number": null,
"primary_contributor_id": null,
"address": null,
"address2": null,
"city": null,
"country": null,
"state": null,
"zip": null,
"sms_opt_in": false,
"notes_check_in": null,
"vip": false,
"created_by": "Jon Doehling",
"created_at": "2020-02-11 09:04:36PM",
"last_edited_by": "Jon Doehling",
"last_edited_at": "2020-02-21 12:01:15AM",
"group": null,
"email_opt": false,
"checked_in": false,
"arrived": false,
"bidding": false
},
{
"contributor_id": 37789,
"event_contributor_id": 69752,
"contributor_types": [
"Sponsor",
"Volunteer"
],
"first_name": "Jonathan",
"last_name": "Doehling",
"cell": "(720) 988-4177",
"email": "jon@aes-oc.com",
"company": null,
"alternate_key": null,
"bidder_number": null,
"primary_contributor_id": null,
"address": "7 Cottage Hill Ln",
"address2": null,
"city": "Ladera Ranch",
"country": "United States of America",
"state": "CALIFORNIA",
"zip": "92694",
"sms_opt_in": false,
"notes_check_in": null,
"vip": false,
"created_by": "Jon Doehling",
"created_at": "2020-02-11 09:04:59PM",
"last_edited_by": "Jenny Test",
"last_edited_at": "2020-04-02 03:53:12PM",
"group": null,
"email_opt": false,
"checked_in": true,
"arrived": true,
"bidding": true
},
]
