{% extends "base.html" %} {% set active_page = "help" %} {% block content %} {% if not project_id %} {% set project_id=1 %} {% endif %}

{{brand}}: API Help

{{brand}} has a RESTful API that can be used for getting information about tasks, submitting contributions, etc. The API end point is available at:

Projects API end point

To get a list of available projects:

To search for a specific project:


Tasks API end point

To get a list of available tasks:

To get the tasks for a given project:

Or, to get a list of completed tasks for a given project:


Task Runs API end point

To get a list of contributions:

To get the contributions for a given project:


Note: GET actions are limited to only 20 items by default, you can use limit and offset to tune the number of results. For further information read the documentation.

For more information about the API please, see the PyBossa documentation and the step by step tutorial.

{% endblock %}