Fundraisers
Overview
fundraisers are FlipGive's object to track a user's activity in the context of a Campaign. A user has many fundraisers, a campaign has many fundraisers, and a user has many campaigns through fundraisers. The combination of user_id and capaign_id must be unique, so a user only has one fundraiser per campaign.
Actions
This endpoint can be authenticated with both a partner_token and identified_token containing both user_data and campaign_data.
Index
Request
Path | /rewards/fundraisers
Verb | GET
Required Parameters:
This endpoint does not have mandatory parameters, however, if a identified token is used, the endpoint will return only the fundraiser that matches the user and campaign contained in the token.
Optional Parameters:
- page:
- limit: Integer, defaults to
100, maximum of100. Example:/rewards/intents?currency=USD&page[limit]=50 - offset: Integer, defaults to
0. Example:/rewards/intents?currency=USD&page[limit]=50&page[offset]=50
- limit: Integer, defaults to
- filters:
- user_id: String, the ID corresponding to one passed through the identified token.
- campaign_id: String, the ID corresponding to one passed through the identified token.
- order:
- name: String, one of
["DESC", "ASC"], will order fundraisers by their name in the requested order. - email: String, one of
["DESC", "ASC"], will order fundraisers by their email date in the requested order. - created_at: TimeStamp, one of
["DESC", "ASC"], defaults toDESC, will order intents by their creation date in the requested order.
- name: String, one of
Response
The API's response will follow the jsonapi standard. The attributes inside the data object will be as follows:
fundraisers:
self: contains the url and params of the current request. next: contains the ur and params for the next page of results, if any.
Attributes:
| Attributes | Type | Description |
|---|---|---|
| name | String | The user's name, copied to the fundraiser. |
| String | The user's email, copied to the fundraiser. | |
| flipgive_user_id | Integer | The ID for the user on FlipGive's database. |
| flipgive_campaign_id | Integer | The ID for the campaign on FlipGive's database. |
| partner_user_id | String | The ID of the user, as passed through by our partner on the identified token. |
| partner_campaign_id | String | The ID of the campaign, as passed through by our partner on the identified token. |
| created_at | TimeStamp | Date and Time when the fundraiser was created. |
| updated_at | TimeStamp | Date and Time when the fundraiser wasupdated. |
| unread_notifications_count | Integer | The total count of unread notifications for the fundraiser. |
| unread_notifications_by_verb_count | Object | The count of unread notifications by verb for the fundraiser. |
Verbs:
| Verbs | Description |
|---|---|
| broadcast_dripped | A message that is dynamically sent when certain conditions are met. |
| broadcasted | A message that is sent to a fixed audience. |
| commented | A comment has been made in one of the fundraiser's activity feed posts. |
| credited | A credit has been awarded to the fundraiser. |
| donated | A donation has been made to the fundraiser's active campaign. |
| earned | Cashback has been earned by the fundraiser. |
| joined | A new user has joined the fundraiser's campaign. |
| posted | A new post has been made to the fundraiser's campaign feed. |