This guide is written for developers using API v1. It’s meant to provide necessary resources to smoothly transition to API v2 and is intended for use in conjunction with the API V2 Documentation.

Please note that while a majority of core Classy components are available in V2, certain methods, such as aggregates, are in active development.

See the Deprecation Schedule for details and timelines.

Endpoint Changes

V1.0 Endpoint (https://classy.org/api1)	V2.0 Endpoint (https://api.classy.org/2.0)	Description
`/account-info`	`/organizations/{id}`	Returns Organization info for the Organization resource that matches the provided URL parameters.
`/account-activity`	`/organizations/{id}/activity`	Returns Organization Activity for the matched Organization resource.
`/account-sponsor-matching`	`/campaigns/{id}/donation-matching-plans`	Returns Donation Matching Plans for the matched Campaign resource.
`/campaigns`	`/organizations/{id}/campaigns`	Returns a collection of Campaigns belonging to the matched Organization resource.
`/campaign-info`	`/campaigns/{id}`	Return an individual Campaign Resource.
`/campaign-tickets`	`/campaigns/{id}/tickets`	Returns Campaigns belonging to the matched Organization resource.
`/fundraisers`	`/campaigns/{id}/fundraising-pages`	Returns a collection of Fundraising Pages belonging to the Campaign resource.
`/fundraisers-info`	`/fundraising-pages/{id}`	Returns an individual Fundraising Page resource.
`/teams`	`/campaigns/{id}/fundraising-teams`	Returns a collection of Fundraising Teams belonging to the matched Campaign resource.
`/team-info`	`/fundraising-teams/{id}`	Returns an individual Fundraising Team resource.
`/team-create`	`TBD`	Endpoint in development.
`/donations`	`/organizations/{id}/transactions`	Returns a collection of Transactions made to the matched Organization resource.
	`/campaigns/{id}/transactions`	Returns a collection of Transactions made to the matched Campaign resource.
`/recurring`	`/organizations/{id}/recurring-donation-plans`	Returns a collection of Recurring Donation Plans belonging to the matched Organization resource.
	`/campaigns/{id}/recurring-donation-plans`	Returns a collection of Recurring Donation Plans belonging to the matched Campaign resource.
`/project-info`	`/designation/{id}`	Returns an individual Designation (formerly known as a 'Project') resource.
`/tickets`	`/campaigns/{id}/ticket-types`	Returns a collection of Ticket Types belonging to the matched Campaign resource.

The following examples demonstrate how to use Version 2 of the Classy API to replicate the behavior of Version 1. All code snippets are written in Python. For a detailed explanation of each resource, please see the API Reference document.

Authentication

Classy API Version 2.0 uses the OAuth2 protocol for authentication against the API.

The API currently supports password and client_credentials grant types. For the examples in this guide, you will need to use the password grant type to generate a member token.

Fetch a token using a client_credentials grant type:

POST /oauth2/auth HTTP/1.1 Host: api.classy.org Content-Type: application/json; charset=utf-8 { "grant_type": "client_credentials", "client_id": "{CLIENT_ID}", "secret_key": "{SECRET_KEY}" }

import requests import json import os credentials = { 'client_id': os.environ['API_CLIENT_ID'], 'secret_key': os.environ['API_SECRET_KEY'], 'grant_type': 'client_credentials' } response = requests.post( 'https://api.classy.org/oauth2/auth', data=credentials ) access_token = response.json()['access_token']
Use the member token to make an API request:

GET /2.0/me HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

import requests # Where {access_token} is the previously fetch token (see Authentication) auth_header = { 'Authorization': 'Bearer {access_token}' } response = requests.get( 'https://api.classy.org/2.0/me', headers=auth_header )

Members

Fetching my member info - Returns the member record associated with this account:

GET /2.0/me HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

import requests import json auth_header = { "Authorization": "Bearer %s" % access_token } base_url = "https://api.classy.org" # Retrieve my member info using the "me" endpoint response = requests.get( "%s/2.0/me" % base_url, headers=auth_header ) # Retrieve my member ID from the JSON response member_id = response.json()['id']
Fetching a Member's Organizations:

GET /2.0/members/{id}/organizations HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

# Using my member ID, fetch all the organization that I have access to: response = requests.get( "%s/2.0/members/%d/organizations" % (base_url, int(member_id)), headers=auth_header ) # I am pretty popular, so I probably belong to several organizations. Let's # use the first in the response: organization_id = response.json()['data'][0]['id']

Organizations

Fetch an Organization record:

GET /2.0/organizations/{organization_id} HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

response = requests.get( "%s/2.0/organisations/%d" % (base_url, int(organization_id)), headers=auth_header ) organization = response.json() organization_id = response.json()['id']
Fetch Organization account activity:

GET /2.0/organizations/{organization_id}/activity HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

# Organization Activity: response = requests.get( "%s/2.0/organizations/%d/activity" % (base_url, int(organization_id)), headers=auth_header ) organization_activity = response.json()['data']

Campaigns

Fetch a collection of Campaigns associated with an Organization:

GET /2.0/organizations/{organization_id}/campaigns HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

# Fetch the first 10 crowdfunding campaigns for this organization: response = requests.get( "%s/2.0/organizations/%d/campaigns?filter=type%%3Dcrowdfunding&fields=id&per_page=10&page=1" % (base_url, int(organization_id)), headers=auth_header ) campaigns = response.json()['data']
Fetch an individual Campaign resource:

GET /2.0/campaigns/{campaign_id} HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

# Fetch an individual campaign response = requests.get( "%s/2.0/campaigns/%d" % (base_url, campaign_id), headers=auth_header ) campaign = response.json() # Campaign Overview / Metrics # Note: Only crowdfunding and donation Campaign types are currently supported: response = requests.get( "%s/2.0/campaigns/%d/overview" % (base_url, campaign_id), headers=auth_header ) overview = response.json() # Retrieve our transaction_count for this Campaign resource: transactions_count = overview['transactions_count']
Fetch a collection of Ticket Types for a given Campaign:

GET /2.0/campaigns/{campaign_id}/ticket-types HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

response = requests.get( "%s/2.0/campaigns/%d/ticket-types" % (base_url, ticketed_campaign_id), headers=auth_header ) campaign_tickets = response.json()['data']
Fetch Donation Matching Plans (Sponsor Matching) associated with a Campaign:

GET /2.0/campaigns/{campaign_id}/donation-matching-plans HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

response = requests.get( "%s/2.0/campaigns/%d/donation-matching-plans" % (base_url, campaign_id), headers=auth_header ) plans = response.json()['data']

Fundraising Pages

Fetch Fundraising Pages associated with a Campaign:

GET /2.0/campaigns/{campaign_id}/fundraising-pages HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

response = requests.get( "%s/2.0/campaigns/%d/fundraising-pages" % (base_url, campaign_id), headers=auth_header ) fundraising_pages = response.json()
Fetch an individual Fundraising Page Resource:

GET /2.0/fundraising-pages/{fundraising_page_id} HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

response = requests.get( "%s/2.0/fundraising-pages/%d" % (base_url, page_id), headers=auth_header ) fundraising_page = response.json()

Fundraising Teams

Fetch a collection of Fundraising Teams:

GET /2.0/campaigns/{campaign_id}/fundraising-pages HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

# Fetch the first 10 fundraising teams response = requests.get( "%s/2.0/campaigns/%d/fundraising-teams?per_page=10&page=1" % (base_url, campaign_id), headers=auth_header ) teams = response.json()['data']
Fetch an individual Fundraising Page resource:

GET /2.0/fundraising-pages/{fundraising_page_id} HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

# Fetch a individual Team response = requests.get( "%s/2.0/fundraising-teams/%d" % (base_url, team_id), headers=auth_header ) team = response.json()

Transactions

Fetch a collection of Transactions to a given Organization:

GET /2.0/organizations/{organization_id}/transactions HTTP/1.1 Host: api.classy.org Authorization: Bearer a2eccdb8B35c

# Fetch organization transactions: response = requests.get( "%s/2.0/organizations/%d/transactions" % (base_url, organization_id), headers=auth_header ) organization_transactions = response.json()['data']
Fetch a collection of Transactions to a given Campaign:

GET /2.0/campaigns/{campaign_id}/transactions HTTP/1.1 Host: api.classy.org

# Fetch campaign transactions: response = requests.get( "%s/2.0/campaigns/%d/transactions" % (base_url, campaign_id), headers=auth_header ) campaign_transactions = response.json()['data']
Fetch an individual Transaction

GET /2.0/transactions/{transaction_id} HTTP/1.1 Host: api.classy.org

# Fetch individual transaction response = requests.get( "%s/2.0/transactions/%d" % (base_url, transaction_id), headers=auth_header ) transaction = response.json()

Recurring Donation Plans

Fetch a collection of Recurring Donation Plans for an Organization:

GET /2.0/organizations/{organization_id}/recurring-donation-plans HTTP/1.1 Host: api.classy.org

# Organization Recurrings - from our zipcode (92101) response = requests.get( "%s/2.0/organizations/%d/recurring-donation-plans?filter=postal_code%%3D92101" % (base_url, organization_id), headers=auth_header ) organization_recurring = response.json()['data']
Fetch a collection of Recurring Donation Plans for a Campaign:

GET /2.0/campaigns/{campaign_id}/recurring-donation-plans HTTP/1.1 Host: api.classy.org

# Campaign Recurring response = requests.get( "%s/2.0/campaigns/%d/recurring-donation-plans" % (base_url, campaign_id), headers=auth_header ) campaign_recurring = response.json()['data']
Fetch an individual Recurring Donation Plan:

GET /2.0/recurring-donation-plans/{recurring_plan_id} HTTP/1.1 Host: api.classy.org

response = requests.get( "%s/2.0/recurring-donation-plans/%d" % (base_url, recurring_id), headers=auth_header ) recurring_plan = response.json()

Designations (Projects)

Fetch a collection of Designations for a given Organization:

GET /2.0/organizations/{organization_id}/designations HTTP/1.1 Host: api.classy.org

# Fetch organization designations with a goal > 1000 response = requests.get( "%s/2.0/organizations/%d/designations?filter=goal%%3E1000" % (base_url, organization_id), headers=auth_header ) designations = response.json()
Fetch a an individual Designation:

GET /2.0/designations/{designation_id} HTTP/1.1 Host: api.classy.org

response = requests.get( "%s/2.0/designations/%d" % (base_url, designation_id), headers=auth_header ) designation = response.json()

Ticket Types (Tickets)

Fetch a collection of Ticket Types for a given Campaign:

GET /2.0/campaigns/{campaign_id}/ticket-types HTTP/1.1 Host: api.classy.org

response = requests.get( "%s/2.0/campaigns/%d/ticket-types" % (base_url, campaign_id), headers=auth_header ) campaign_tickets = response.json()['data']

V2 Migration Guide