Get campaign returns data regarding a campaign with the ability to extend this request for specific aspects of the campaign.
\n","urlObject":{"protocol":"https","path":["api","v1","campaign","96"],"host":["api","charidy","com"],"query":[{"description":{"content":"The extend returns the list of streams on the campaign and information about each stream.
\nThe attributes includes:\nid: The id of the stream,\ncampaign_id: The id of the campaign,\ntitle: The title of the stream,\nkey: The unique key associated to the stream,\nvisible: Makes the stream available to donate towards,\ngoal: The goal towards this stream,\ntotal: The amount donated towards this stream,\nimage: The image associated towards the stream,\ncolor: The color associated to the stream,\ndescription: The description of the stream,\norder: The order which the stream is ordered,\ndefault: Whether or not this is the default stream that will be donated towards,\ngateway_id: The gateway that will be used to donate towards this stream
\n","type":"text/plain"},"key":"extend[]","value":"donation_stream"},{"description":{"content":"The extend returns the list of matchers on the campaign and information about each individual matcher.
\nThe attributes include:\nid: The id of the matcher,\ncampaign_id: The id of the campaign,\nname: The name of the matcher,\ndescription: The description of the matcher,\nimage: The image associated to the matcher,\nactive: Whether or not the matcher is an active matcher,\ngoal: The amount the matcher will match until,\nfeatured: Whether or not the matcher is a featured matcher,\ntag: Flexible field to be used for features on campaigns
\n","type":"text/plain"},"key":"extend[]","value":"matchers"},{"description":{"content":"This extend returns donation info about the number of donors and the total the campaign has raised so far.
\nThe attriburtes includes:\ntotal: The total amount of money earned by this campaign,\ndonors_total: The total number of donors in this campaign
\n","type":"text/plain"},"key":"extend[]","value":"campaign_stats"},{"description":{"content":"This extend returns the largest donation made in the campaign.
\nThe attributes includes:\ntotal: The amount of the largest donation,\ncurrency_code: The currency which the donation was made in
\n","type":"text/plain"},"key":"extend[]","value":"largest_donation"},{"description":{"content":"This extend returns all the metas activated on the campaign and is set to true.
\nThe attributes include:\nid: the id of the meta,\ncampaign_id: the id of the campaign,\nmeta_name: The name of the meta,\nmeta_data: The value of the meta such as if it on or off and any related meta settings
\n","type":"text/plain"},"key":"extend[]","value":"metas"},{"description":{"content":"This extend gives any campaign descriptions that exist in this campaign by language and campaign status.
\nThe attributes include:
id - the id of the description, \ncampaign_id - the campaign id of the campaign, \nlanguage - the language code of the description, \ncontent - the html content of the description,
tag - the tag associated to the status of the campaign
This extend lists all teams associated to the campaign.
\nThe attributes include:\nid: the id of the team,\ncampaign_id: the id of the campaign,\nslug: The shortend name of the team,\nshortlink: The shortlink to get to the team,\nname: The team name,\ndescription: The description of the team,\ngoal: The team goal,\ncolor: The color the team is connected to,\nimage: The image related to the team,\nsort: The order the team will show up,\ndonated: Amount the team has raised so far,\ndonated_children: The amount the children team have raised,\ndonation_n: The number of donors the team has,\ndonation_n_children: The number of donors the children team have,\nis_parent: Whether or not the team is a parent team,\ngroup: The group the team is included in,\nparent_team_id: The ID of the parent team if applicable,\nparent_level: The level of the parent team
\n","type":"text/plain"},"key":"extend[]","value":"teams"},{"description":{"content":"This extend lists all images used for this campaign.
\nThe attributes include: \nid - the id of the image, \ncampaign_id - the campaign id of the campaign, \ntag - the tag associated to the image,
src - the image location, \norder - the priority of the image.
This extend returns data about the organization running this campaign.
\nThe attributes include: \nid: the id of the organization,\norgname: Organization Name,\nabout: Description of the organization,\navatar: The image associated to the organization,\nfacebookurl: Facebook link to the organization,\ntwitterurl: Twitter link to the organization,\ninstagram: Instagram link to the organization,\ntimezone: The timezone the organization is working in,\nwebsite: The website related to the organization,\npublic_address: The physical address of the organization,\npublic_phone: The phone number of the organization,\npublic_email: The email associated to the organization,\ncampaigns: Campaigns the organization it has run
\n","type":"text/plain"},"key":"extend[]","value":"orgnaization"},{"description":{"content":"The extend returns the list of levels on the campaign and information about each level.
\nThe attributes includes:\nid: The id of the level,\ncampaign_id: The id of the campaign,\ntitle: The title of the level,\nsubtitle: The subtitle of the level,\namount: The amount that the level will set as the donation amount,\nimage: The image associated to the level,\ncurrency: The currency the level will use to donate,\ncolor: The color for the level background,\nlimited: This limits the amount of times this level can be used to donate,\navailable: This tracks how many more times this level can be used to donate,\ngateway_id: This will set which gateway will be used when donating with this level,\norder: This sets the order in which the levels are arranged
\n","type":"text/plain"},"key":"extend[]","value":"donation_level"}],"variable":[]}},"response":[],"_postman_id":"cf2f2dd5-e313-4816-9e47-e2dc1e6a743a"},{"name":"Get Campaign Donation List","id":"85dfe282-05fb-41b0-bd81-f407be9c0057","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.charidy.com/api/v1/campaign/96/donations?sortBy=-time&limit=1&fromDonationID=0&extend=team&include_children_campaign_donations=1&extend=campaign&extend=organization&include_common_fund_donations=1&extend=level","description":"This GET will return all the donations within a campaign with information about each donation.
\n","urlObject":{"protocol":"https","path":["api","v1","campaign","96","donations"],"host":["api","charidy","com"],"query":[{"description":{"content":"This sorts the donations by the time the donation was made in order based on the value of the param.
\n","type":"text/plain"},"key":"sortBy","value":"-time"},{"description":{"content":"This will limit the number of donations that will be returned based on the value of the param.
\n","type":"text/plain"},"key":"limit","value":"1"},{"description":{"content":"This will return all donations made after this donation ID.
\n","type":"text/plain"},"key":"fromDonationID","value":"0"},{"description":{"content":"The extend will return the team that this donation was made towards.
\n","type":"text/plain"},"key":"extend","value":"team"},{"description":{"content":"If the value is set to 1 it will return all donations from the main giving day campaign in the API call and any donations that were made to the children giving day campaigns as well.
\n","type":"text/plain"},"key":"include_children_campaign_donations","value":"1"},{"description":{"content":"This extend will give information about the campaign the donation was made towards.
\nThe attributes include: \ncampaign_id: The id of the campaign,\ncurrency: The currency the campaign goal is set to,\ncurrency_sign: The symbol of the currency the campaign goal is set to,\nabout_campaign: The description of the campaign,\nshort_link: The shortlink to access the campaign,\nstart_date: The start date of the campaign with timezone,\nend_date: The end date of the campaign with timezone,\ncampaign_video: The videos that are added to this campaign,\ncampaign_image: The images associated to the campaign,\ncampaign_extra_images: Additional images used within the campaign,\nrounds: Will show any bonus rounds set to the campaign,\ntitle: The title of the campaign,\nshort_description: The short description for this campaign,\ncampaign_mobile_image: The images set for this campaign in mobile view,\nmode: The mode the campaign is currently in such as live, countdown, or success,\ntype: The type of campaign,\ntheme: The theme layout of the campaign such as classic or unidy,\ncategory: The category of this campaign,\ngivingday_id: The id of the givingday if this campaign is associated to a giving day,\ntext_to_pledge_number: The phone number to be used to donate over the phone
\n","type":"text/plain"},"key":"extend","value":"campaign"},{"description":{"content":"This extend will include info about the organization that is running the campaign .
\nThe attributes include: \nid: the id of the organization,\norgname: Organization Name,\nabout: Description of the organization,\navatar: The image associated to the organization,\nfacebookurl: Facebook link to the organization,\ntwitterurl: Twitter link to the organization,\ninstagram: Instagram link to the organization,\ntimezone: The timezone the organization is working in,\nwebsite: The website related to the organization,\npublic_address: The physical address of the organization,\npublic_phone: The phone number of the organization,\npublic_email: The email associated to the organization,\ncampaigns: Campaigns the organization it has run
\n","type":"text/plain"},"key":"extend","value":"organization"},{"description":{"content":"If the value is set to 1 it will return the donations of this campaign and any donations allocated to this campaign from the main giving day campaign.
\n","type":"text/plain"},"key":"include_common_fund_donations","value":"1"},{"description":{"content":"This extend will include the level that was used to make this donation.
\n","type":"text/plain"},"key":"extend","value":"level"}],"variable":[]}},"response":[],"_postman_id":"85dfe282-05fb-41b0-bd81-f407be9c0057"},{"name":"Get Campaign Teams","id":"3c69ff57-863c-4fca-b800-cf049caf0fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.charidy.com/api/v1/campaign/4947/teams?grouped=1&offset=1&limit=50&sort=-amount&parent_only=0&grandparent_only=0&skip_parent=0&parent_team_id","description":"This will return all the teams within a campaign and the information about the teams.
\n","urlObject":{"protocol":"https","path":["api","v1","campaign","4947","teams"],"host":["api","charidy","com"],"query":[{"key":"grouped","value":"1"},{"description":{"content":"List the campaign teams starting after a certain number
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"This limits the nymber of teams returned.
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"This sorts the teams by different variable such as: -name, -amount, -count to sort desc
\n","type":"text/plain"},"key":"sort","value":"-amount"},{"description":{"content":"This will return only the parent teams
\n","type":"text/plain"},"key":"parent_only","value":"0"},{"key":"grandparent_only","value":"0"},{"description":{"content":"This will not return any parent teams
\n","type":"text/plain"},"key":"skip_parent","value":"0"},{"description":{"content":"This will include the parent team id of any teams that have a parent team
\n","type":"text/plain"},"key":"parent_team_id","value":null}],"variable":[]}},"response":[],"_postman_id":"3c69ff57-863c-4fca-b800-cf049caf0fa8"}]}