API Entry Point (AEP) Version 2

This document describes the OSDI API entry point (AEP) as implemented by the Action Network.

The AEP is the top level entry point for Action Network's API. It provides links to other resource entry points, such as a collection of petition resources in the system, documentation, and other messages. By starting at the AEP and following successive links, an API user should be able to reach all URLs available on the API.

Sections:

• Endpoints and URL structures
• Field names and descriptions
• Links
• Related resources
• Scenario: Retrieving the API entry point resource (GET)
• Scenario: POST/PUT/DELETE

Endpoints and URL structures

Endpoints:

https://actionnetwork.org/api/v2/

The AEP is located at the above link, and all collections and resources stem from that basic URL structure.

URL Structures:

https://actionnetwork.org/api/v2/[resource_type]

To address a specific type of resources, use the resource type name like https://actionnetwork.org/api/v2/petitions

Back To Top ↑

Field names and descriptions

API Entry Point fields:

Back To Top ↑

Links

Back To Top ↑

Related resources

• People
• Events
• Petitions
• Fundraising Pages
• Donations
• Advocacy Campaigns
• Metadata
• Lists
• Forms
• Tags
• Event Campaigns
• Campaigns
• Surveys
• Person Signup Helper

Back To Top ↑

Scenario: Retrieving the API entry point resource (GET)

Calling the AEP link will return the API entry point resource.

Request

						
GET https://actionnetwork.org/api/v2/

Header:
OSDI-API-Token: your_api_key_here
					

Response

						
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate


	{
	  "motd": "Welcome to the Action Network OSDI API v2 Entry Point!",
	  "_links": {
	    "curies": [
	      {
	        "name": "osdi",
	        "href": "https://actionnetwork.org/docs/v2/{rel}",
	        "templated": true
	      },
	      {
	        "name": "action_network",
	        "href": "https://actionnetwork.org/docs/v2/{rel}",
	        "templated": true
	      }
	    ],
	    "canvasser:brand_logo": {
	      "href": "https://actionnetwork.org/images/logo.png",
	      "title": "The branding logo for use in UI"
	    },
	    "docs": {
	      "href": "https://actionnetwork.org/docs/",
	      "title": "Documentation",
	      "name": "Docs",
	      "index": "index"
	    },
	    "self": {
	      "title": "This API entry point",
	      "href": "https://actionnetwork.org/api/v2/"
	    },
	    "osdi:people": {
	      "title": "The collection of people in the system",
	      "href": "https://actionnetwork.org/api/v2/people"
	    },
	    "osdi:events": {
	      "title": "The collection of events in the system",
	      "href": "https://actionnetwork.org/api/v2/events"
	    },
	    "osdi:petitions": {
	      "title": "The collection of petitions in the system",
	      "href": "https://actionnetwork.org/api/v2/petitions"
	    },
	    "osdi:fundraising_pages": {
	      "title": "The collection of fundraising_pages in the system",
	      "href": "https://actionnetwork.org/api/v2/fundraising_pages"
	    },
	    "osdi:donations": {
	      "title": "The collection of donations in the system",
	      "href": "https://actionnetwork.org/api/v2/donations"
	    },
	    "osdi:queries": {
	      "title": "The collection of queries in the system",
	      "href": "https://actionnetwork.org/api/v2/queries"
	    },
	    "osdi:forms": {
	      "title": "The collection of forms in the system",
	      "href": "https://actionnetwork.org/api/v2/forms"
	    },
	    "action_network:event_campaigns": {
	      "title": "The collection of event campaigns in the system",
	      "href": "https://actionnetwork.org/api/v2/event_campaigns"
	    },
	    "action_network:campaigns": {
	      "title": "The collection of campaigns in the system",
	      "href": "https://actionnetwork.org/api/v2/campaigns"
	    },
	    "osdi:tags": {
	      "title": "The collection of tags in the system",
	      "href": "https://actionnetwork.org/api/v2/tags"
	    },
	    "osdi:lists": {
	      "title": "The collection of lists in the system",
	      "href": "https://actionnetwork.org/api/v2/lists"
	    },
	    "osdi:wrappers": {
	      "title": "The collection of email wrappers in the system",
	      "href": "https://actionnetwork.org/api/v2/wrappers"
	    },
	    "osdi:messages": {
	      "title": "The collection of messages in the system",
	      "href": "https://actionnetwork.org/api/v2/messages"
	    },
	    "osdi:person_signup_helper": {
	      "title": "Person Signup Helper",
	      "href": "https://actionnetwork.org/api/v2/people"
	    },
	    "osdi:advocacy_campaigns": {
	      "title": "The collection of advocacy_campaigns in the system",
	      "href": "https://actionnetwork.org/api/v2/advocacy_campaigns"
	    },
	    "action_network:surveys": {
	      "title": "The collection of surveys in the system",
	      "href": "https://actionnetwork.org/api/v2/surveys"
	    },
	    "osdi:metadata": {
	      "title": "The collection of metadata in the system",
	      "href": "https://actionnetwork.org/api/v2/metadata"
	    }
	  },
	  "max_page_size": 25,
	  "vendor_name": "Action Network",
	  "product_name": "Action Network",
	  "namespace": "action_network",
	  "osdi_version": "1.1.1"
	}
					

Back To Top ↑

Scenario: POST/PUT/DELETE

Posting, putting, and deleting on the AEP is not allowed. Attempts will result in errors.

Back To Top ↑