Retrieve a list of organizations, also called brigades.
/api/organizations
/api/organizations?param=value¶m2=value2
http://api.codeforamerica.org/api/organizations
{
"pages": {
"next": …,
"last": …
},
"objects": [
{
"type": "Brigade",
"name": "Open Oakland",
…
},
{
"type": "Code for All",
"name": "Code for Berlin",
…
},
…
]
}
http://api.codeforamerica.org/api/organizations?type=Brigade
{
"pages": {
"next": …,
"last": …
},
"objects": [
{
"type": "Brigade, Code for All",
"name": "OK Lab Hamburg",
…
},
{
"type": "Brigade",
"name": "Code for Puerto Rico",
…
},
…
]
}
Retrieve a list of organizations, in GeoJSON format for geographic applications.
/api/organizations.geojson
FeatureCollection
Feature
http://api.codeforamerica.org/api/organizations.geojson
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"id": "Open-Oakland",
"geometry": {
"type": "Point",
"coordinates": [ -122.2711, 37.8044 ]
},
"properties": {
"name": "Open Oakland",
"website": "http://openoakland.org/",
"city": "Oakland, CA",
…
}
},
…
]
}
Retrieve a single organization.
/api/organizations/{organization id}
http://api.codeforamerica.org/api/organizations/Open-Oakland
{
"type": "Brigade",
"name": "Open Oakland",
"id" : "Open-Oakland",
"website": "http://openoakland.org/",
"city": "Oakland, CA",
"latitude": 37.8044,
"longitude": -122.2711,
"api_url": "http://api.codeforamerica.org/api/organizations/Open-Oakland",
"started_on": "2012-12-25",
"current_events": [ … ],
"all_events": "http://api.codeforamerica.org/api/organizations/Open-Oakland/events",
"events_url": "http://www.meetup.com/OpenOakland/",
"current_projects": [ … ],
"all_projects": "http://api.codeforamerica.org/api/organizations/Open-Oakland/projects",
"projects_list_url": "https://docs.google.com/spreadsheet/pub?key=0AgNZYWcpRBQ7dHRnTUJtd3QtYkR5bk5lUmpNMDlpSEE&single=true&gid=0&output=csv",
"current_stories": [ … ],
"all_stories": "http://api.codeforamerica.org/api/organizations/Open-Oakland/stories",
"rss": ""
}
Retrieve a list of projects. Projects are ordered by most recent update.
/api/projects
/api/projects?param=value¶m2=value2
/api/organizations/{organization id}/projects
http://api.codeforamerica.org/api/projects
{
"pages": {
"next": …,
"last": …
},
"objects": [
{
"id": 1,
"name": "cityvoice",
"link_url": "http://www.cityvoiceapp.com/",
"code_url": "https://github.com/codeforamerica/cityvoice",
"api_url": "http://api.codeforamerica.org/api/projects/1",
"categories": "community engagement, housing",
"description": "A place-based call-in system for gathering and sharing community feedback",
"github_details": { … },
"organization": { … },
"organization_name": "Code for America",
"tags": ["community engagement", "housing"],
"type": "web service",
"status": "In Progress",
"issues": [ … ],
"commit_status": "success"
},
{
"id": 2,
"name": "Adopt-a-Thingie",
…
},
…
]
}
http://api.codeforamerica.org/api/projects?categories=Knowledge&organization_type=Brigade
{
"pages": {
"next": …,
"last": …
},
"objects": [
{
"id": 1,
"name": "myPhillyRising",
"link_url": "http://www.myphillyrising.com/",
"code_url": "https://github.com/openplans/myphillyrising/",
"api_url": "http://api.codeforamerica.org/api/projects/74",
"categories": "Knowledge",
"description": "myPhillyRising",
"github_details": { … },
"organization": {
"name": "Philly",
"type": "Brigade, Code for All"
},
"organization_name": "Philly",
"tags": ["neighborhoods", "news"],
"type": "",
"status": "",
"issues": [ … ],
"commit_status": "success"
},
{
"id": 2,
"name": "LocalWiki",
…
},
…
]
}
Retrieve a single project.
/api/projects/{project id}
http://api.codeforamerica.org/api/projects/1
{
"id": 1,
"name": "cityvoice",
"link_url": "http://www.cityvoiceapp.com/",
"code_url": "https://github.com/codeforamerica/cityvoice",
"api_url": "http://api.codeforamerica.org/api/projects/1",
"categories": "community engagement, housing",
"status": "In Progress",
"description": "A place-based call-in system for gathering and sharing community feedback",
"organization": { … },
"organization_name": "Code for America",
"tags": ["community engagement", "housing"],
"type": "web service",
"github_details":
{
"id": 10515516,
"contributors": [ … ],
"contributors_url": "https://api.github.com/repos/codeforamerica/cityvoice/contributors",
"created_at": "2013-06-06T00:12:30Z",
"description": "A place-based call-in system for gathering and sharing community feedback",
"forks_count": 18,
"homepage": "http://www.cityvoiceapp.com/",
"html_url": "https://github.com/codeforamerica/cityvoice",
"name": "cityvoice",
"open_issues": 38,
"owner": { … },
"participation": [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 18, 13, 0, 0, 83, 20, 11, 25, 63, 66 ],
"project_needs": [],
"pushed_at": "2014-03-29T20:03:41Z",
"updated_at": "2014-03-29T20:03:41Z",
"watchers_count": 14
}
"issues": [
{
"id": 1,
"title": "Consider using Universal Analytics for Google Analytics",
"api_url": "http://codeforamerica.org/api/issues/193",
"body": "Google has officially released Universal Analytics about 2 months ago, …",
"html_url": "https://github.com/codeforamerica/cityvoice/issues/193",
"labels": [
{
"color": "84b6eb",
"name": "enhancement",
"url": "https://api.github.com/repos/codeforamerica/cityvoice/labels/enhancement"
}
],
"project": { … },
"project_name": "cityvoice",
},
{ … }
],
"languages" : [
"Python",
"CSS",
"HTML"
]
}
Retrieve a list of events.
/api/events
/api/events/upcoming_events
/api/events/past_events
/api/organizations/{organization id}/events
/api/organizations/{organization id}/upcoming_events
/api/organizations/{organization id}/past_events
http://api.codeforamerica.org/api/events
{
"pages": {
"next": …,
"last": …
},
"objects": [
{
"id": 1,
"name": "OpenOakland Civic Hack Night",
"description": "<p>Join us for our weekly civic hack sessions inside City Hall.</p>",
"event_url": "http://www.meetup.com/OpenOakland/events/qbjtcgytdbfb/",
"api_url": "http://api.codeforamerica.org/api/events/1",
"location": null,
"start_time": "2015-02-03 18:30:00 -0800",
"end_time": null,
"organization": { … },
"organization_name": "Open Oakland",
"created_at": "2013-06-04 20:31:29"
},
{
"id": 2,
"name": "Get Out There And Do Something",
…
},
…
]
}
Retrieve a single event.
/api/events/{event id}
YYYY-MM-DD HH:MM:SS ZZZZ
format, local to event if possible.YYYY-MM-DD HH:MM:SS ZZZZ
format, local to event if possible.http://api.codeforamerica.org/api/events/1
{
"id": 1,
"name": "OpenOakland Civic Hack Night",
"description": "<p>Join us for our weekly civic hack sessions inside City Hall.</p>",
"event_url": "http://www.meetup.com/OpenOakland/events/qbjtcgytdbfb/",
"api_url": "http://api.codeforamerica.org/api/events/1",
"location": null,
"start_time": "2015-02-03 18:30:00 -0800",
"end_time": null,
"organization": { … },
"organization_name": "Open Oakland",
"created_at": "2013-06-04 20:31:29"
}
Retrieve a list of stories.
/api/stories
/api/organizations/{organization id}/stories
http://api.codeforamerica.org/api/stories
{
"pages": {
"next": …,
"last": …
},
"objects": [
{
"id": 1,
"title": "Here Are Our Values",
"link": "http://www.codeforamerica.org/blog/2014/03/27/here-are-our-values/",
"organization": { … },
"organization_name": "Code for San Francisco",
"type": "blog"
},
{
"id": 2,
"name": "Get Out There And Do Something",
…
},
…
]
}
Retrieve a single story.
/api/stories/{story id}
http://api.codeforamerica.org/api/stories/1
{
"id": 1,
"title": "Here Are Our Values",
"link": "http://www.codeforamerica.org/blog/2014/03/27/here-are-our-values/",
"organization": { … },
"organization_name": "Code for San Francisco",
"type": "blog"
}
Retrieve a list of project issues.
/api/issues
/api/issues/labels/{label name(s)}
http://api.codeforamerica.org/api/issues
{
"pages": {
"next": …,
"last": …
},
"objects": [
{
"id": 1,
"title": "Write some tests",
"api_url": "http://codeforamerica.org/api/issues/2",
"body": "Start writing tests. ",
"html_url": "https://github.com/sfbrigade/ballot_initiatives/issues/7",
"labels": [
{
"color": "84b6eb",
"name": "enhancement",
"url": "https://api.github.com/repos/sfbrigade/ballot_initiatives/labels/enhancement"
}
],
"project": { … },
"project_name": "ballot_initiatives",
},
{
"id": 2,
"title": "Import SFGOV data set",
…
},
…
]
}
http://api.codeforamerica.org/api/issues/labels/enhancement
{
"pages": {
"next": …,
"last": …
},
"objects": [
{
"id": 1,
"title": "Write some tests",
"api_url": "http://codeforamerica.org/api/issues/2",
"body": "Start writing tests. ",
"html_url": "https://github.com/sfbrigade/ballot_initiatives/issues/7",
"labels": [
{
"color": "84b6eb",
"name": "enhancement",
"url": "https://api.github.com/repos/sfbrigade/ballot_initiatives/labels/enhancement"
}
],
"project": { … },
"project_name": "ballot_initiatives",
},
{
"id": 2,
"title": "help for non-service residents",
"labels": [
{
"color": "84b6eb",
"name": "enhancement",
"url": "https://api.github.com/repos/open-austin/austin-recycles/labels/enhancement"
},
{
"color": "fef2c0",
"name": "hack",
"url": "https://api.github.com/repos/open-austin/austin-recycles/labels/hack"
}
]
…
},
…
]
}
http://api.codeforamerica.org/api/issues?organization_type=Code for All
[
{
api_url: "http://localhost:5000/api/issues/27",
body: "",
html_url: "https://github.com/CfABrigadePhiladelphia/laddr/issues/34",
id: 27,
labels: [ ... ],
project: { ... },
title: "create admin UI on profile page for promoting other users' account level"
}
, ...
]
Retrieve a single issue.
/api/issues/{issue id}
http://api.codeforamerica.org/api/issues/1
{
"id": 1,
"title": "Write some tests",
"api_url": "http://codeforamerica.org/api/issues/2",
"body": "Start writing tests. ",
"html_url": "https://github.com/sfbrigade/ballot_initiatives/issues/7",
"labels": [
{
"color": "84b6eb",
"name": "enhancement",
"url": "https://api.github.com/repos/sfbrigade/ballot_initiatives/labels/enhancement"
}
],
"project": { … },
"project_name": "ballot_initiatives",
}