We the People API: Resources & Documentation

In 2014, We the People officially launched a "write" version of the Petitions Application Programming Interface, or "API." Using the API, people can sign We the People petitions even when they’re not on WhiteHouse.gov. Now, users can also use third-party platforms, including other petitions services, or even their own websites or blogs to submit signatures and access publicly available data on petitions. All of those signatures, once validated, will count towards a petition’s objective of meeting the 100,000-signature threshold needed for an official White House response.

Below find resources and documentation to help you use the API.

Quick Info:

  • About the API: Learn more about why we created an API
  • Request Key: To use the Write API and submit signatures from your own petitions to the We the People platform, you need an API key. Request one here
  • Terms: Use of the Write API is governed by an additional Terms of Use.
  • Stability: Users issuing requests/posts in excess of 1,500 per minute may experience degraded performance and may be blocked entirely.
  • Just the Data: For those who don't need to implement the API, but want to see the data it provides, every month we provide a SQL download that you can learn from. Want to take a look? You can download it here.
  • Examples: See examples of how others have used We the People API and their GitHub repositories.

Contact us if you have any questions about the API.


petitions

GET /v1/petitions

Returns a list of petitions, individual petitions, and signatures attached to an individual petition.

Details

  • Non-Latin characters are replaced with an "x".
  • Limits: 10 requests per second.
  • Developers who need historic data on all public petitions should consider using our bulk data download, described above.

Arguments
  • int isPublic GET (optional)
    When set to 1, this will only return petitions that are public.
  • int isSignable GET (optional)
    When set to 1, this will only return petitions accepting signatures. When set to 0, returns only un-signable petitions.
  • int createdBefore GET (optional)
    Filters results to display items created before specified time. Accepts Unix timestamp. (There's a handy unix timestamp converter here.)
  • int createdAfter GET (optional)
    Filters results to display items created after specified time. Accepts Unix timestamp. (There's a handy unix timestamp converter here.)
  • int createdAt GET (optional)
    Filters results to display items created (or published) at specified time. Accepts Unix timestamp. (There's a handy unix timestamp converter here.)
  • int limit GET (optional)
    The maximum number of results that may be returned. E.g., to return results 10-20, an offset of 10 and limit of 10 would be passed. Maximum limit is 1000; developers who need historic data on all public petitions should consider using our bulk data download, described above.
  • int offset GET (optional)
    Offset the returned results by this number. E.g., to return results 10-20, an offset of 10 and limit of 10 would be passed.
  • string title GET (optional)
    Filters results by keyword or phrase in the Title.
  • string body GET (optional)
    Filters results by keyword or phrase in the Body.
  • int signatureThresholdCeiling GET (optional)
    Filters results by maximum Signature Threshold.
  • int signatureThreshold GET (optional)
    Filters results by exact Signature Threshold.
  • int signatureThresholdFloor GET (optional)
    Filters results by minimum Signature Threshold.
  • int signatureCountCeiling GET (optional)
    Filters results by maximum Signature Count.
  • int signatureCount GET (optional)
    Filters results by exact Signature Count.
  • int signatureCountFloor GET (optional)
    Filters results by minimum Signature Count.
  • string url GET (optional)
    Filters results by Petition URL.
  • string status GET (optional)
    Filters results by Status. Allowed values are "open", "pending response", "responded", and "closed".
  • int responseID GET (optional)
    Filters results by Response ID .
  • int responseAssociationTimeBefore GET (optional)
    Filters results to display items with a Response Assocation before a specified time. Accepts Unix timestamp.
  • string sortBy GET (optional)
    Sets the field by which to sort results. Allowed values are "signature_count" and "date_reached_public".
  • string sortOrder GET (optional)
    The order by which to sort. Allowed values are "asc" and "desc".
  • int mock GET (optional)
    When set to 1, this will cause the service to return a mock response.
Request Example
https://api.whitehouse.gov/v1/petitions.json?limit=3&offset=0&createdBefore=1352924535
Response Example
{
  "metadata": {
    "responseInfo": {
      "status": 200,
      "developerMessage": "OK",
      "userMessage": "",
      "errorCode": "",
      "moreInfo": ""
    },
    "requestInfo": {
      "apiVersion": 1,
      "resource": "petitions",
      "query": {
        "body": null,
        "createdAfter": null,
        "createdAt": null,
        "createdBefore": "1352924535",
        "isPublic": 1,
        "isSignable": null,
        "limit": "3",
        "mock": 0,
        "offset": "0",
        "petitionsDefaultLimit": 1000,
        "publicThreshold": 149,
        "responseId": null,
        "signatureCount": null,
        "signatureCountCeiling": null,
        "signatureCountFloor": 0,
        "signatureThreshold": null,
        "signatureThresholdCeiling": null,
        "signatureThresholdFloor": null,
        "sortBy": "DATE_REACHED_PUBLIC",
        "sortOrder": "ASC",
        "status": null,
        "title": null,
        "url": null,
        "websiteUrl": "https://petitions.trumpwhitehouse.archives.gov"
      }
    },
    "resultset": {
      "count": 809,
      "limit": 3,
      "offset": 0
    }
  },
  "results": [
    {
      "id": "226511",
      "type": "petition",
      "title": "Ban the practice of circumcising individuals under the age of 18.",
      "body": "Circumcision is a barbaric tribal practice that amounts to child abuse. Before any individual under go any permanent body modification such as tattooing or sex reassignment surgery they must be considered old enough to understand the consequences. You cannot understand the ramifications of this act to your physical being until after puberty, when your genitals have fully developed. ",
      "issues": [
        {
          "id": 4,
          "name": "Civil Rights and Liberties"
        },
        {
          "id": 25,
          "name": "Health Care"
        },
        {
          "id": 28,
          "name": "Human Rights"
        }
      ],
      "signatureThreshold": 25000,
      "signatureCount": 3085,
      "signaturesNeeded": 21915,
      "url": "https://petitions.trumpwhitehouse.archives.gov/petition/ban-practice-circumcising-individuals-under-age-18",
      "deadline": 1355512735,
      "status": "closed",
      "response": [

      ],
      "created": 1352920735,
      "isSignable": false,
      "isPublic": true,
      "reachedPublic": 1354231182
    },
    {
      "id": "224306",
      "type": "petition",
      "title": "Remove HEMP (Non-Psychoactive Cannabis) from the Federal governments banned substance list. Make it Legal to Grow in USA",
      "body": "There is no reason for it to be illegal. It won't make you high. It is Not Marijuana, and it alone could make enough oil to free the nation. Hemp is the most versatile plant in the Universe, its strong enough to make rope, and diverse enough to make oil. This plant will grow almost everywhere with very little maintenance and without watering.And it is insect resistant naturally. It grows quickly and the steps to turn it into gasoline are very simple. We could replace our need for anything other than hemp in a matter of Months, not years.\r\n\r\nFuel:\r\n\r\n* Hemp can produce 10 times more methanol than corn. \r\n* Hemp is Earth's number-one biomass resource; it is capable of producing 10 tons per acre in four months.\r\n",
      "issues": [
        {
          "id": 1,
          "name": "Agriculture"
        },
        {
          "id": 3,
          "name": "Budget and Taxes"
        },
        {
          "id": 20,
          "name": "Environment"
        }
      ],
      "signatureThreshold": 25000,
      "signatureCount": 5091,
      "signaturesNeeded": 19909,
      "url": "https://petitions.trumpwhitehouse.archives.gov/petition/remove-hemp-non-psychoactive-cannabis-federal-governments-banned-substance-list-make-it",
      "deadline": 1355510348,
      "status": "closed",
      "response": [

      ],
      "created": 1352918348,
      "isSignable": false,
      "isPublic": true
    },
    {
      "id": "224016",
      "type": "petition",
      "title": "Stop the US Diversity Immigrant Visa (Lottery) Program - \"The USA's Open Door Welfare Program\"...",
      "body": "Millions of Americans don't realize what's going on in this country.\r\nAnyone can fill out an online application form, then \"WIN\" the right to come to this country and claim all the benefits. The LOTTERY makes available up to 55,000 diversity visas annually, drawn from random selection BY COMPUTER; they are just WINNING\" permanent resident status based on no qualifications!\r\nAs a result, government officials are admitting millions of immigrants each year who are dependent on Medicaid, child care benefits, foster care, energy assistance, education assistance, nutritional welfare programs and other medical and health benefits.\r\nWe cant afford for our government to promote a policy that encourages immigrants to apply for a green card Lottery and \"WIN\"- NOT DESERVE the right to become USA citizen!",
      "issues": [
        {
          "id": 29,
          "name": "Immigration"
        }
      ],
      "signatureThreshold": 25000,
      "signatureCount": 2819,
      "signaturesNeeded": 22181,
      "url": "https://petitions.trumpwhitehouse.archives.gov/petition/stop-us-diversity-immigrant-visa-lottery-program-usas-open-door-welfare-program",
      "deadline": 1355509876,
      "status": "closed",
      "response": [

      ],
      "created": 1352917876,
      "isSignable": false,
      "isPublic": true,
      "reachedPublic": 1353496598
    }
  ]
}
Errors
What happens in case of an unknown error?
If the request fails due to an unpredicted problem, what will the response look like?
{
  "metadata": {
    "responseInfo": {
      "status": "599",
      "developerMessage:": "Sorry. Something went wrong. We're not sure what. And we're not sure 599 is an accurate status code for your error. Please file a ticket in the issue queue to help us understand what caused this error: https://github.com/whitehouse/petitions/issues?state=open",
      "userMessage": "",
      "errorCode": "",
      "moreInfo": ""
    }
  }
}
    

GET /v1/petitions/{petition_id}

Returns a petition matching the petition id.

Arguments
  • string petition_id URL
    The petition id of the petition to get.
  • int mock GET (optional)
    When set to 1, this will cause the service to return a mock response.
Request Example
https://api.whitehouse.gov/v1/petitions.json?limit=3&offset=0&createdBefore=1352924535
Response Example
{
  "metadata": {
    "responseInfo": {
      "status": 200,
      "developerMessage": "OK",
      "userMessage": "",
      "errorCode": "",
      "moreInfo": ""
    },
    "resultset": {
      "count": 1,
      "limit": 1,
      "offset": 0
    }
  },
"results": [
  {
    "id": "226511",
    "type": "petition",
    "title": "Secure resources and funding, and begin construction of a Death Star by 2016.",
    "body": "Those who sign here petition the United States government to secure funding and resources, and begin construction on a Death Star by 2016.\r\n\r\nBy focusing our defense resources into a space-superiority platform and weapon system such as a Death Star, the government can spur job creation in the fields of construction, engineering, space exploration, and more, and strengthen our national defense.\r\n\r\n",
    "issues": [
      {
        "id": 12,
        "name": "Defense"
      },
      {
        "id": 97,
        "name": "Job Creation"
      },
      {
        "id": 139,
        "name": "Science and Space Policy"
      }
    ],
    "signatureThreshold": 25000,
    "signatureCount": 34435,
    "signaturesNeeded": 0,
    "url": "https://petitions.whitehouse.gov/petition/secure-resources-and-funding-and-begin-construction-death-star-2016",
    "deadline": 1355516840,
    "status": "responded",
    "response": {
      "id": 716,
      "url": "https://petitions.whitehouse.gov/response/isnt-petition-response-youre-looking",
      "associationTime": 1357944472
    },
    "created": 1352924840,
    "isSignable": false,
    "isPublic": true,
    "reachedPublic": 1354231182
  }
]
}
Errors
What happens if an invalid petition ID is requested?
If the request specifies an invalid petition ID, what will the response look like?
{
  "metadata": {
    "responseInfo": {
      "status": "404",
      "developerMessage:": "404 Not Found : Petition {petition_id} not found.",
      "userMessage": "The petition that you requested does not exist.",
      "errorCode": "84",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#petitions-retrieve-error-404"
    }
  }
}
    
What happens in case of server error?
If the request fails due to a server problem, what will the response look like?
{
  "metadata": {
    "responseInfo": {
      "status": "599",
      "developerMessage:": "Class could not be instantiated.",
      "userMessage": "The resource that you requested is temporarily unavailable.",
      "errorCode": "83",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#petitions-retrieve-error-599"
    }
  }
}
    
Implementation Examples
JavaScript
Thermometer
Display the status of a petition as a thermometer.

GET /v1/petitions/{petition_id}/signatures

Display signatures attached to a petition. Unsupported non-Latin characters are replaced with an "x".

Arguments
  • string petition_id URL
    The petition id of the petition whose signatures we are getting.
  • int createdBefore GET (optional)
    Filters results to display items created before specified time. Accepts Unix timestamp. (There's a handy unix timestamp converter here.)
  • int createdAfter GET (optional)
    Filters results to display items created after specified time. Accepts Unix timestamp. (There's a handy unix timestamp converter here.)
  • int createdAt GET (optional)
    Filters results to display items created before specified time. Accepts Unix timestamp. (There's a handy unix timestamp converter here.)
  • int limit GET (optional)
    The maximum number of results that may be returned. E.g., to return results 10-20, an offset of 10 and limit of 10 would be passed. Maximum limit is 1000; developers who need historic data on all public petitions should consider using our bulk data download, described above.
  • int offset GET (optional)
    Offset the returned results by this number. E.g., to return results 10-20, an offset of 10 and limit of 10 would be passed.
  • int mock GET (optional)
    When set to 1, this will cause the service to return a mock response.
Request Example
https://api.whitehouse.gov/v1/petitions.json?limit=3&offset=0&createdBefore=1352924535
Response Example
{
  "metadata": {
    "responseInfo": {
      "status": 200,
      "developerMessage": "OK",
      "userMessage": "",
      "errorCode": "",
      "moreInfo": ""
    },
    "resultset": {
      "count": 16,
      "limit": 16,
      "offset": 0
    }
  },
  "results": [
    {
      "id": "50a3fea8c988d48611000014",
      "type": "signature",
      "petitionId": "226511",
      "name": "J. D.",
      "created": "1352924840"
    },
    {
      "id": "50a4041ab15a7af576000019",
      "type": "signature",
      "petitionId": "226511",
      "name": "N. R.",
      "created": "1352926234"
    },
    {
      "id": "50a406de704301152600000b",
      "type": "signature",
      "petitionId": "226511",
      "name": "A. M.",
      "created": "1352926942"
    },
    {
      "id": "50a4076dc988d4256d000012",
      "type": "signature",
      "petitionId": "226511",
      "name": "J. A.",
      "created": "1352927085"
    },
    {
      "id": "50a409647043015728000009",
      "type": "signature",
      "petitionId": "226511",
      "name": "E. S.",
      "created": "1352927588"
    },
    {
      "id": "50a409c6c988d4187a00001f",
      "type": "signature",
      "petitionId": "226511",
      "name": "P. D.",
      "created": "1352927686"
    },
    {
      "id": "50a40e3cc988d41b2c000005",
      "type": "signature",
      "petitionId": "226511",
      "name": "J. C.",
      "created": "1352928828"
    },
    {
      "id": "50a40fd5c988d4723f000003",
      "type": "signature",
      "petitionId": "226511",
      "name": "T. M.",
      "created": "1352929237"
    },
    {
      "id": "50a42150cde5b86625000014",
      "type": "signature",
      "petitionId": "226511",
      "name": "W. W.",
      "created": "1352933712"
    },
    {
      "id": "50a450fc6ce61cc57800000c",
      "type": "signature",
      "petitionId": "226511",
      "name": "M. P.",
      "created": "1352945916"
    },
    {
      "id": "50a453f7688938c60a000003",
      "type": "signature",
      "petitionId": "226511",
      "name": "K. O.",
      "created": "1352946679"
    },
    {
      "id": "50a45798b15a7a1b5700000b",
      "type": "signature",
      "petitionId": "226511",
      "name": "S. P.",
      "created": "1352947608"
    },
    {
      "id": "50a470b52f2c88732800000e",
      "type": "signature",
      "petitionId": "226511",
      "name": "S. E.",
      "created": "1352954037"
    },
    {
      "id": "50a474b92f2c88786000000f",
      "type": "signature",
      "petitionId": "226511",
      "name": "G. B.",
      "created": "1352955065"
    },
    {
      "id": "50a47ca7704301066c000011",
      "type": "signature",
      "petitionId": "226511",
      "name": "M. S.",
      "created": "1352957095"
    },
    {
      "id": "50a47e1e8cce3fee2500000d",
      "type": "signature",
      "petitionId": "226511",
      "name": "R. A.",
      "created": "1352957470"
    }
  ]
}
Errors
What happens if an invalid petition ID is requested?
If the request specifies an invalid petition ID, what will the response look like?
{
  "metadata": {
    "responseInfo": {
      "status": "404",
      "developerMessage:": "404 Not Found : Petition {petition_id} not found.",
      "userMessage": "The petition that you requested does not exist.",
      "errorCode": "84",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#petitions-signatures-error-404"
    }
  }
}
    
What happens in case of server error?
If the request fails due to a server problem, what will the response look like?
{
  "metadata": {
    "responseInfo": {
      "status": "599",
      "developerMessage:": "Class could not be instantiated.",
      "userMessage": "The resource that you requested is temporarily unavailable.",
      "errorCode": "83",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#petitions-signatures-error-599"
    }
  }
}
    

responses

GET /v1/responses

Returns a list of responses matching passed parameters.

Arguments
  • string petitionId GET (optional)
    Filters results to display responses for a specific petition.
  • string sortBy GET (optional)
    Sets the field by which to sort results. Allowed values are "age".
  • string sortOrder GET (optional)
    The order by which to sort. Allowed values are "asc" and "desc".
  • int limit GET (optional)
    The maximum number of results that may be returned. E.g., to return results 10-20, an offset of 10 and limit of 10 would be passed. Maximum limit is 50;
  • int offset GET (optional)
    Offset the returned results by this number. E.g., to return results 10-20, an offset of 10 and limit of 10 would be passed.
  • int mock GET (optional)
    When set to 1, this will cause the service to return a mock response.
Request Example
https://api.whitehouse.gov/v1/petitions.json?limit=3&offset=0&createdBefore=1352924535
Response Example
{
  "metadata": {
    "execution time": 0.020001
  },
  "results": [
    {
      "id": 2150256,
      "title": "A response to your petition on the OPT STEM regulation:",
      "body": "<p>On September 8, <a href=\"https://petitions.whitehouse.gov/petition/propose-proper-regulation-extending-stem-opt-022016-avoid-expected-shock-both-firms-and-students\" style=\"color: #336699;\">a petition you signed</a> -- asking the Administration to put in place a new set of rules for the extension of the Optional Practical Training program for international students in science, technology, engineering, and math (\"OPT STEM\") -- reached 100,000 signatures, the threshold for receiving a White House response.</p>\n\n      <p>First, thanks for using We the People. In order to get information to respond to your request, we consulted with folks from the Department of Homeland Security -- the agency that administers the OPT STEM program. Here's what we can share:</p>\n\n      <p>For more than 200 years, the United States has welcomed immigrants and refugees from around the world into our nation, enhancing our diversity, culture, and economy. Today, many individuals contributing to the science, technology, engineering, and math (STEM) fields are immigrants or refugees, and research indicates that skilled immigrants make outsized contributions to innovation and entrepreneurship, which helps grow our economy and create jobs for all Americans. That is why the President has consistently advocated for commonsense comprehensive immigration reform legislation that would help certain foreign students who graduate with STEM degrees to stay here and contribute to our economy by providing these individuals with avenues to obtain lawful permanent residence (or \"green cards\").</p>\n\n      <p>Last November, the President announced a number of reforms designed to fix parts of our broken immigration system -- including actions to strengthen the Optional Practical Training (OPT) STEM program. <strong>Last week, the Department of Homeland Security published a proposed regulation to accomplish this goal. DHS is inviting the public, including students, colleges and universities, and employers, to review its proposed reforms and provide feedback by November 18, 2015.</strong> After DHS reviews and considers all public comments, it plans to publish a final rule.</p>\n\n      <p><strong><a href=\"https://www.federalregister.gov/articles/2015/10/19/2015-26395/improving-and-expanding-training-opportunities-for-f-1-nonimmigrant-students-with-stem-degrees-and\" style=\"color: #336699;\">You can read the proposed regulation here.</a></strong></p>\n\n      <p>Wondering what exactly this process is all about? Here's a quick run-down:</p>\n\n      <p>Federal regulations are created through a rulemaking process. These regulations provide a roadmap for how federal agencies will implement certain laws, policies, and programs. Once an agency decides it should take a regulatory action, that agency will typically develop and publish a notice of proposed rulemaking (or \"NPRM\") in the Federal Register -- the official daily publication for agency rules, proposed rules, and notices of Federal agencies and organizations, as well as Executive Orders and other Presidential documents. (<a href=\"https://www.federalregister.gov\" style=\"color: #336699;\">You can take a look here.</a>) Once the NPRM is published, the agency begins soliciting comments from the public about the proposed rule. After the comment period closes, the rulemaking agency considers every comment, and makes any changes in the rule where appropriate. The final rule typically incorporates feedback and changes from the comment period and is then published in the Federal Register. A final rule will include a specific date on which the rule will become effective. To learn more about the rulemaking process, visit, <a href=\"http://www.reginfo.gov/public/jsp/Utilities/faq.jsp\" style=\"color: #336699;\">www.reginfo.gov</a> -- and take a look at some commonly asked questions and answers about the process here. </p>\n\n      <p>For more information on the President’s immigration executive actions, including improvements to attract high skilled graduates and entrepreneurs, visit&nbsp;<a href=\"https://www.whitehouse.gov/blog/2014/11/25/taking-action-attract-high-skilled-immigrants-graduates-and-entrepreneurs\" style=\"color: #336699;\">https://www.whitehouse.gov/blog/2014/11/25/taking-action-attract-high-skilled-immigrants-graduates-and-entrepreneurs</a> and <a href=\"https://www.whitehouse.gov/issues/immigration/immigration-action\" style=\"color: #336699;\">www.whitehouse.gov/immigration-action</a>.</p> \n\n      <p>And to get more updates on immigration issues, please visit <a href=\"https://www.whitehouse.gov/immigration\" style=\"color: #336699;\">www.whitehouse.gov/immigration</a>. </p>\n\n      <p>Thank you for your participation in the We the People platform -- we’ll be back in touch soon.</p>\n\n      <p>-- The We the People Team</p>\n\n      <hr />\n\n      <p><em><a href=\"https://www.whitehouse.gov/webform/tell-us-what-you-think-about-we-people-and-petition-response-opt-stem-regulations\" style=\"color: #336699;\">Tell us what you think about this response and We the People.</a></em></p>",
      "petitions": [
        {
          "id": "2086961",
          "url": "https://petitions.whitehouse.gov/petition/propose-proper-regulation-extending-stem-opt-022016-avoid-expected-shock-both-firms-and-students",
          "relative_url" : "/petition/propose-proper-regulation-extending-stem-opt-022016-avoid-expected-shock-both-firms-and-students",
          "short_url" : "http://wh.gov/i5sAk",
          "title" : "propose a proper regulation for extending the STEM OPT before 02/2016 to avoid expected shock to both firms and students",
          "signature_count" : "103655",
          "timestamp_reached_ready" : "1441721950"
        }
      ],
      "url": "https://petitions.whitehouse.gov/response/response-your-petition-opt-stem-regulation",
      "relative_url": "/response/response-your-petition-opt-stem-regulation",
      "agency": "White House, Department of Homeland Security",
      "issues": [
        {
          "id": "18",
          "name": "Education"
        },
        {
          "id": "29",
          "name": "Immigration"
        }
      ],
      "created": 1446129165
    },
    {
      "id": 2142931,
      "title": "An initial response to your petition on a Medicare local coverage determination:",
      "body": "<p>Thanks for using We the People, and for sharing your concerns about the local coverage determination for lower limb prostheses proposed by Medicare contractors. In order to get the most up-to-date information concerning your petition, we've gone to the Department of Health and Human Services (HHS) -- specifically, the Centers for Medicare and Medicaid Services (CMS), and the Administration for Community Living (ACL).</p>\n      <p><a href=\"https://www.cms.gov/medicare/coverage/determinationprocess/LCDs.html\" style=\"color: #336699;\"><strong>You can learn more about LCDs and how they're determined here.</strong></a></p>\n\n      <p>The coverage determination process is still ongoing, but CMS wants to make clear that they’re committed to providing high quality care to all Medicare beneficiaries. They also wanted to make sure you know that HHS has met with stakeholders on this important issue, and both CMS and its contractors understand the questions that have been raised about access to the right prosthetic care -- including related technologies -- for Medicare beneficiaries.</p>\n\n      <p>We will be in touch with another update.</p>\n\n      <p>--The We the People Team</p>\n\n      <hr />\n\n      <p><a href=\"https://www.whitehouse.gov/webform/tell-us-what-you-think-about-we-people-and-petition-response-medicare-and-prostheses\" style=\"color: #336699;\">Tell us what you think about this response and We the People.</a></p>\n\n      <hr />\n      <p><strong>Update 11/02/15:</strong></p>\n      <p style=\"font-size:14pt;\"><strong>An updated response to your petition on a Medicare local coverage determination:</strong></p>\n\n      <p>A couple weeks ago, we passed along an initial response to your petition. Today, there's more to say. The Centers for Medicare & Medicaid Services (CMS) -- the relevant body within the federal government responsible for addressing this issue -- announced that the Durable Medical Equipment Medicare Administrative Contractors (DME MACs) will not finalize the draft Lower Limb Prostheses Local Coverage Determination (LCD) (DL33787) at this time. <a href=\"https://www.cms.gov/Medicare/Coverage/DeterminationProcess/Downloads/LLP_IAWG_Announcement.pdf\" style=\"color:#336699;\" target=\"_blank\">You can read the official announcement here.</a></p>\n\n      <p>Here's what else they'd like you to know:</p>\n\n      <p><strong>CMS is committed to providing high quality care to all Medicare beneficiaries, including any beneficiary in need of a prosthesis. Both CMS and its contractors have heard your concerns about access to prostheses for Medicare beneficiaries.</strong></p>\n\n      <p>After a preliminary review of the public comments, CMS is convening a multidisciplinary Lower Limb Prostheses Interagency Workgroup (Workgroup) in 2016. The purpose of the Workgroup is to develop a consensus statement that informs Medicare policy by reviewing the available clinical evidence that defines best practices in the care of beneficiaries who require lower limb prostheses. The Workgroup will be comprised of clinicians, researchers, and policy specialists from different federal agencies. The Workgroup may also identify areas where evidence gaps exist related to the prescription of lower extremity prostheses, and make recommendations concerning the study designs and outcome measures that best inform patient oriented function, quality of life, and service satisfaction in this realm. CMS will ensure there is opportunity for public comment and engagement on the Workgroup consensus statement and any related activities. </p>\n\n      <p>The federal government looks forward to working with the public to ensure appropriate access to prostheses. </p>\n\n      <p>Thanks so much for raising your voice around this issue -- and for your continued advocacy around it.</p>\n\n      <p>The We the People Team</p>",
      "petitions": [
        {
          "id": "2074366",
          "url": "https://petitions.whitehouse.gov/petition/rescind-medicare-proposal-restricting-access-prosthetic-limbs-and-returning-amputees-1970s-standards-care",
          "relative_url" : "/petition/rescind-medicare-proposal-restricting-access-prosthetic-limbs-and-returning-amputees-1970s-standards-care",
          "short_url" : "http://wh.gov/iIIoi",
          "title" : "Rescind the Medicare proposal restricting access to prosthetic limbs and returning amputees to 1970’s standards of care.",
          "signature_count" : "110136",
          "timestamp_reached_ready" : "1439823473"
        }
      ],
      "url": "https://petitions.whitehouse.gov/response/initial-response-your-petition-medicare-local-coverage-determination",
      "relative_url": "/response/initial-response-your-petition-medicare-local-coverage-determination",
      "agency": "The White House, Department of Health and Human Services",
      "issues": [
        {
          "id": "25",
          "name": "Health Care"
        }
      ],
      "created": 1445044041
    },
    {
      "id": 681,
      "title": "A Message from President Obama about Your Petition on Reducing Gun Violence",
      "body": "<p>By Bruce Reed</p><p>In the days since the tragedy in Newtown, Americans from all over the country have called for action to deter mass shootings and reduce gun violence. Hundreds of thousands of you have signed petitions on the White House's We the People petitions platform.</p>\n      <p>I&#39;m writing you today to thank you for speaking up, to update you on an important development, and to encourage you to continue engaging with the White House on this critical issue.</p>\n      <p>First, you should know that President Obama is paying close to attention to the public response to this tragedy. In fact, he sat down to record a message specifically for those of you who have joined the conversation using We the People. Watch it now: </p>\n      <p><iframe width=\"520\" height=\"293\" src=\"https://www.youtube-nocookie.com/embed/u5ynVMBxOus?rel=0\" frameborder=\"0\" allowfullscreen></iframe></p>\n      <p><a href=\"http://www.youtube.com/watch?v=u5ynVMBxOus\" class=\"no-follow\">Watch this video on YouTube</a></p>\n      <p>On December 19, the President outlined a series of first steps we can take to begin the work of ending this cycle of violence. This is what he said:</p>\n      <p style=\"padding-left:30px; padding-right:30px; text-align:justify;\">We know this is a complex issue that stirs deeply held passions and political divides. And as I said on Sunday night, there&#39;s no law or set of laws that can prevent every senseless act of violence in our society. We&#39;re going to need to work on making access to mental health care at least as easy as access to a gun. We&#39;re going to need to look more closely at a culture that all too often glorifies guns and violence. And any actions we must take must begin inside the home and inside our hearts.</p>\n      <p style=\"padding-left:30px; padding-right:30px; text-align:justify;\">But the fact that this problem is complex can no longer be an excuse for doing nothing. The fact that we can&#39;t prevent every act of violence doesn&#39;t mean we can&#39;t steadily reduce the violence, and prevent the very worst violence.</p>\n      <p>Vice President Biden has been asked to work with members of the Administration, Congress, and the general public to come up with a set of concrete policy proposals by next month -- proposals the President intends to push swiftly. The President asked the Vice President to lead this effort in part because he wrote and passed the 1994 Crime Bill that helped law enforcement bring down the rate of violent crime in America. That bill included the assault weapons ban, which expired in 2004.</p>\n      <p>As the Vice President&#39;s Chief of Staff, I&#39;m going to do everything I can to ensure we run a process that includes perspectives from all sides of the issue, which is why I wanted to respond to your petition myself. Two decades ago, as domestic policy adviser in the Clinton White House, I first worked with Joe Biden as he fought to enact the Crime Bill, the assault weapons ban, and the Brady Bill. I will never forget what a key role the voices of concerned citizens like you played in that vital process.</p>\n      <p>The President called on Congress to pass important legislation \"banning the sale of military-style assault weapons,\" \"banning the sale of high-capacity ammunition clips,\" and \"requiring background checks before all gun purchases, so that criminals can’t take advantage of legal loopholes to buy a gun from somebody who won’t take the responsibility of doing a background check at all.\"</p>\n      <p>An issue this serious and complex isn&#39;t going to be resolved with a single legislative proposal or policy prescription. And let&#39;s be clear, any action we take will respect the Second Amendment. As the President said:</p>\n      <p style=\"padding-left:30px; padding-right:30px; text-align:justify;\">Look, like the majority of Americans, I believe that the Second Amendment guarantees an individual right to bear arms. This country has a strong tradition of gun ownership that&#39;s been handed down from generation to generation. Obviously across the country there are regional differences. There are differences between how people feel in urban areas and rural areas. And the fact is the vast majority of gun owners in America are responsible -- they buy their guns legally and they use them safely, whether for hunting or sport shooting, collection or protection.</p>\n      <p style=\"padding-left:30px; padding-right:30px; text-align:justify;\">But you know what, I am also betting that the majority -- the vast majority -- of responsible, law-abiding gun owners would be some of the first to say that we should be able to keep an irresponsible, law-breaking few from buying a weapon of war. I&#39;m willing to bet that they don&#39;t think that using a gun and using common sense are incompatible ideas -- that an unbalanced man shouldn&#39;t be able to get his hands on a military-style assault rifle so easily; that in this age of technology, we should be able to check someone&#39;s criminal records before he or she can check out at a gun show; that if we work harder to keep guns out of the hands of dangerous people, there would be fewer atrocities like the one in Newtown -- or any of the lesser-known tragedies that visit small towns and big cities all across America every day.</p>\n      <p>The President said it best: &quot;Ultimately if this effort is to succeed it&#39;s going to require the help of the American people -- it&#39;s going to require all of you. If we&#39;re going to change things, it&#39;s going to take a wave of Americans -- mothers and fathers, daughters and sons, pastors, law enforcement, mental health professionals -- and, yes, gun owners -- standing up and saying 'enough' on behalf of our kids.&quot;</p>\n      <p>So let&#39;s continue this conversation and get something meaningful done. If you have additional ideas and are interested in further engagement with the White House on this issue, please let us know and share your thoughts here:</p>\n      <p><a class=\"no-follow\" href=\"http://www.whitehouse.gov/share-your-thoughts-reducing-gun-violence\">http://www.whitehouse.gov/share-your-thoughts-reducing-gun-violence</a></p>\n      <p>Thank you for speaking out and staying involved.</p>\n      <p><em>Bruce Reed is Chief of Staff to Vice President Biden</em></p>",
      "petitions": [
        {
          "id": "319121",
          "url": "https://petitions.whitehouse.gov/petition/start-process-enact-federal-gun-control-reforms",
          "relative_url" : "/petition/start-process-enact-federal-gun-control-reforms",
          "short_url" : "http://wh.gov/RNN1",
          "title" : "Start the process to enact Federal Gun control reforms.",
          "signature_count" : "10452",
          "timestamp_reached_ready" : ""
        },
        {
          "id": "319326",
          "url": "https://petitions.whitehouse.gov/petition/immediately-address-issue-gun-control-through-introduction-legislation-congress",
          "relative_url" : "/petition/immediately-address-issue-gun-control-through-introduction-legislation-congress",
          "short_url" : "http://wh.gov/RN6U",
          "title" : "Immediately address the issue of gun control through the introduction of legislation in Congress.",
          "signature_count" : "197073",
          "timestamp_reached_ready" : "1355527619"
        }
      ],
      "url": "https://petitions.whitehouse.gov/response/message-president-obama-about-your-petition-reducing-gun-violence",
      "relative_url": "/response/message-president-obama-about-your-petition-reducing-gun-violence",
      "agency": "White House",
      "issues": [
        {
          "id": "10",
          "name": "Criminal Justice and Law Enforcement"
        },
        {
          "id": "22",
          "name": "Firearms"
        }
      ],
      "created": 1355963976
    }

  ]
}
Errors
What happens in case of an unknown error?
If the request fails due to an unpredicted problem, what will the response look like?
{
  "metadata": {
    "responseInfo": {
      "status": "599",
      "developerMessage:": "Sorry. Something went wrong. We're not sure what. And we're not sure 599 is an accurate status code for your error. Please file a ticket in the issue queue to help us understand what caused this error: https://github.com/whitehouse/petitions/issues?state=open",
      "userMessage": "",
      "errorCode": "",
      "moreInfo": ""
    }
  }
}
    

GET /v1/responses/{response_id}

Returns a response matching the response id.

Arguments
  • int response_id URL
    The response id of the response to get.
  • int mock GET (optional)
    When set to 1, this will cause the service to return a mock response.
Request Example
https://api.whitehouse.gov/v1/petitions.json?limit=3&offset=0&createdBefore=1352924535
Response Example
{
  "metadata": {
    "execution time": 0.01
  },
  "results": [
    {
      "id": 681,
      "title": "A Message from President Obama about Your Petition on Reducing Gun Violence",
      "body": "<p>By Bruce Reed</p><p>In the days since the tragedy in Newtown, Americans from all over the country have called for action to deter mass shootings and reduce gun violence. Hundreds of thousands of you have signed petitions on the White House's We the People petitions platform.</p>\n      <p>I&#39;m writing you today to thank you for speaking up, to update you on an important development, and to encourage you to continue engaging with the White House on this critical issue.</p>\n      <p>First, you should know that President Obama is paying close to attention to the public response to this tragedy. In fact, he sat down to record a message specifically for those of you who have joined the conversation using We the People. Watch it now: </p>\n      <p><iframe width=\"520\" height=\"293\" src=\"https://www.youtube-nocookie.com/embed/u5ynVMBxOus?rel=0\" frameborder=\"0\" allowfullscreen></iframe></p>\n      <p><a href=\"http://www.youtube.com/watch?v=u5ynVMBxOus\" class=\"no-follow\">Watch this video on YouTube</a></p>\n      <p>On December 19, the President outlined a series of first steps we can take to begin the work of ending this cycle of violence. This is what he said:</p>\n      <p style=\"padding-left:30px; padding-right:30px; text-align:justify;\">We know this is a complex issue that stirs deeply held passions and political divides. And as I said on Sunday night, there&#39;s no law or set of laws that can prevent every senseless act of violence in our society. We&#39;re going to need to work on making access to mental health care at least as easy as access to a gun. We&#39;re going to need to look more closely at a culture that all too often glorifies guns and violence. And any actions we must take must begin inside the home and inside our hearts.</p>\n      <p style=\"padding-left:30px; padding-right:30px; text-align:justify;\">But the fact that this problem is complex can no longer be an excuse for doing nothing. The fact that we can&#39;t prevent every act of violence doesn&#39;t mean we can&#39;t steadily reduce the violence, and prevent the very worst violence.</p>\n      <p>Vice President Biden has been asked to work with members of the Administration, Congress, and the general public to come up with a set of concrete policy proposals by next month -- proposals the President intends to push swiftly. The President asked the Vice President to lead this effort in part because he wrote and passed the 1994 Crime Bill that helped law enforcement bring down the rate of violent crime in America. That bill included the assault weapons ban, which expired in 2004.</p>\n      <p>As the Vice President&#39;s Chief of Staff, I&#39;m going to do everything I can to ensure we run a process that includes perspectives from all sides of the issue, which is why I wanted to respond to your petition myself. Two decades ago, as domestic policy adviser in the Clinton White House, I first worked with Joe Biden as he fought to enact the Crime Bill, the assault weapons ban, and the Brady Bill. I will never forget what a key role the voices of concerned citizens like you played in that vital process.</p>\n      <p>The President called on Congress to pass important legislation \"banning the sale of military-style assault weapons,\" \"banning the sale of high-capacity ammunition clips,\" and \"requiring background checks before all gun purchases, so that criminals can’t take advantage of legal loopholes to buy a gun from somebody who won’t take the responsibility of doing a background check at all.\"</p>\n      <p>An issue this serious and complex isn&#39;t going to be resolved with a single legislative proposal or policy prescription. And let&#39;s be clear, any action we take will respect the Second Amendment. As the President said:</p>\n      <p style=\"padding-left:30px; padding-right:30px; text-align:justify;\">Look, like the majority of Americans, I believe that the Second Amendment guarantees an individual right to bear arms. This country has a strong tradition of gun ownership that&#39;s been handed down from generation to generation. Obviously across the country there are regional differences. There are differences between how people feel in urban areas and rural areas. And the fact is the vast majority of gun owners in America are responsible -- they buy their guns legally and they use them safely, whether for hunting or sport shooting, collection or protection.</p>\n      <p style=\"padding-left:30px; padding-right:30px; text-align:justify;\">But you know what, I am also betting that the majority -- the vast majority -- of responsible, law-abiding gun owners would be some of the first to say that we should be able to keep an irresponsible, law-breaking few from buying a weapon of war. I&#39;m willing to bet that they don&#39;t think that using a gun and using common sense are incompatible ideas -- that an unbalanced man shouldn&#39;t be able to get his hands on a military-style assault rifle so easily; that in this age of technology, we should be able to check someone&#39;s criminal records before he or she can check out at a gun show; that if we work harder to keep guns out of the hands of dangerous people, there would be fewer atrocities like the one in Newtown -- or any of the lesser-known tragedies that visit small towns and big cities all across America every day.</p>\n      <p>The President said it best: &quot;Ultimately if this effort is to succeed it&#39;s going to require the help of the American people -- it&#39;s going to require all of you. If we&#39;re going to change things, it&#39;s going to take a wave of Americans -- mothers and fathers, daughters and sons, pastors, law enforcement, mental health professionals -- and, yes, gun owners -- standing up and saying 'enough' on behalf of our kids.&quot;</p>\n      <p>So let&#39;s continue this conversation and get something meaningful done. If you have additional ideas and are interested in further engagement with the White House on this issue, please let us know and share your thoughts here:</p>\n      <p><a class=\"no-follow\" href=\"http://www.whitehouse.gov/share-your-thoughts-reducing-gun-violence\">http://www.whitehouse.gov/share-your-thoughts-reducing-gun-violence</a></p>\n      <p>Thank you for speaking out and staying involved.</p>\n      <p><em>Bruce Reed is Chief of Staff to Vice President Biden</em></p>",
      "petitions": [
        {
          "id": "319121",
          "url": "https://petitions.whitehouse.gov/petition/start-process-enact-federal-gun-control-reforms",
          "relative_url" : "/petition/start-process-enact-federal-gun-control-reforms",
          "short_url" : "http://wh.gov/RNN1",
          "title" : "Start the process to enact Federal Gun control reforms.",
          "signature_count" : "10452",
          "timestamp_reached_ready" : ""
        },
        {
          "id": "319326",
          "url": "https://petitions.whitehouse.gov/petition/immediately-address-issue-gun-control-through-introduction-legislation-congress",
          "relative_url" : "/petition/immediately-address-issue-gun-control-through-introduction-legislation-congress",
          "short_url" : "http://wh.gov/RN6U",
          "title" : "Immediately address the issue of gun control through the introduction of legislation in Congress.",
          "signature_count" : "197073",
          "timestamp_reached_ready" : "1355527619"
        }
      ],
      "url": "https://petitions.whitehouse.gov/response/message-president-obama-about-your-petition-reducing-gun-violence",
      "relative_url": "/response/message-president-obama-about-your-petition-reducing-gun-violence",
      "agency": "White House",
      "issues": [
        {
          "id": "10",
          "name": "Criminal Justice and Law Enforcement"
        },
        {
          "id": "22",
          "name": "Firearms"
        }
      ],
      "created": 1355963976
    }
  ]
}
Errors
What happens if an invalid response ID is requested?
If the request specifies an invalid response ID, what will the response look like?
{
  "metadata": {
    "responseInfo": {
      "status": "404",
      "developerMessage:": "404 Not Found : Response {response_id} not found.",
      "userMessage": "The response that you requested does not exist.",
      "errorCode": "84",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#responses-retrieve-error-404"
    }
  }
}
    
What happens in case of server error?
If the request fails due to a server problem, what will the response look like?
{
  "metadata": {
    "responseInfo": {
      "status": "599",
      "developerMessage:": "Class could not be instantiated.",
      "userMessage": "The resource that you requested is temporarily unavailable.",
      "errorCode": "83",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#petitions-retrieve-error-599"
    }
  }
}
    

signatures

POST /v1/signatures Authentication Required

Send an independently gathered signature to a petition.

Arguments
  • string api_key GET
    The API Key.
  • array signature POST
    The signature array. The following array keys are required: petition_id, email, first_name, last_name. Accepted request content types: application/json, application/xml, text/xml, application/x-www-form-urlencoded, application/vnd.php.serialized
Request Example
https://api.whitehouse.gov/v1/petitions.json?limit=3&offset=0&createdBefore=1352924535
{
  "petition_id": "PetitionIdGoesHere",
  "email": "john.doe@example.com",
  "first_name": "John",
  "last_name": "Doe"
}
Response Example
{
  "metadata": {
    "responseInfo": {
      "status": 200,
      "developerMessage": "OK",
      "userMessage": "",
      "errorCode": "",
      "moreInfo": ""
    }
  }
}
Errors
What happens if my submission does not include all the required fields?
I am building a web application that will post petition signatures via the write API. I can definitely foresee a scenario where all of the required fields were not gathered. If I am trying to post a signature via the API at http://api.whitehouse.gov/v1/signatures that does not contain all of the required fields, will I get an error response?
{
  "metadata": {
    "responseInfo": {
      "status": "400",
      "developerMessage:": "400 : Missing required fields. These fields are required: signature_source_api_key, petition_id, email, first_name, last_name.",
      "userMessage": "Missing required fields. These fields are required: signature_source_api_key, petition_id, email, first_name, last_name.",
      "errorCode": "75",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#signatures-create-error-400"
    }
  }
}
    
What happens when I pass an invalid API key with my request?
I am building a web application that will submit signatures via the write API. If I pass an invalid API key with my request, will I get a response?
{
  "metadata": {
    "responseInfo": {
      "status": "401",
      "developerMessage:": "401 Unauthorized : Invalid key.",
      "userMessage": "The key provided is not valid.",
      "errorCode": "85",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#signatures-create-error-401"
    }
  }
}
    
What happens when I try to sign a petition that is closed?
I am building a web application that will post petition signatures via the write API. If I am trying to post a signature via the API at http://api.whitehouse.gov/v1/signatures to a petition that is more then 30 days old and has since been closed, will I get a response? If so, is there a different response if the petition was closed prior to the 30 days?
{
  "metadata": {
    "responseInfo": {
      "status": "403",
      "developerMessage:": "Petition {petition_id} cannot accept more signatures. (If you believe this petition was not open for a full 30 days, it's possible that it was flagged and removed for violation of terms of service.)",
      "userMessage": "This petition cannot accept more signatures. You can open a new petition on this issue here: https://petitions.whitehouse.gov/.",
      "errorCode": "74",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#signatures-create-error-403"
    }
  }
}
    
What happens when I try to sign a petition that doesn't exist?
I am building a web application that will post petition signatures via the write API. If I am trying to post a signature via the API at http://api.whitehouse.gov/v1/signatures for a petition that does not actually exist, will I get an error response?
{
  "metadata": {
    "responseInfo": {
      "status": "404",
      "developerMessage:": "404 Not Found : No such petition {petition_id}.",
      "userMessage": "The petition you are trying to sign doesn't exist.",
      "errorCode": "76",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#signatures-create-error-404"
    }
  }
}
    
What happens when the API service is not available?
I am building a web application that will post petition signatures via the write API. If I am trying to post a signature via the API at http://api.whitehouse.gov/v1/signatures and the service is down, will I get a response?
{
  "metadata": {
    "responseInfo": {
      "status": "500",
      "developerMessage:": "Sorry. Service is not available right now.",
      "userMessage": "Sorry. We are unable to process your signature right now.",
      "errorCode": "73",
      "moreInfo": "See the documentation: https://petitions.whitehouse.gov/developers#signatures-create-error-500"
    }
  }
}
    
Return to top