Project Schema

Allowed detail HTTP methods:

GET, POST, PUT, DELETE, PATCH

Allowed list HTTP methods:

GET, POST, PUT, DELETE, PATCH

Default format:

application/json

Default limit:

20

Examples:

List all projects

Example Request

$ curl https://app.getblimp.com/api/v2/project/ \
    -H "Authorization: ApiKey USERNAME:API_KEY" \
    -H "X_BLIMP_APPID: APPLICATION_ID" \
    -H "X_BLIMP_SECRET: APPLICATION_SECRET"

Example Response

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "company": "/api/v2/company/1/",
            "date_created": "2013-01-11T02:01:18.211115",
            "date_due": null,
            "date_finished": null,
            "date_modified": "2013-01-11T02:03:37.926453",
            "date_started": null,
            "id": 49,
            "name": "Public API",
            "resource_uri": "/api/v2/project/49/",
            "slug": "public-api",
            "state": "inactive",
            "stats": {
                "goals_active": 0,
                "goals_all": 0,
                "goals_done": 0,
                "goals_inactive": 0,
                "goals_review": 0,
                "progress": 0
            },
            "team": [
                "/api/v2/user/2/"
            ]
        },
        {
            "company": "/api/v2/company/1/",
            "date_created": "2013-01-15T02:18:07.106197",
            "date_due": null,
            "date_finished": null,
            "date_modified": "2013-01-15T02:18:07.106240",
            "date_started": null,
            "id": 50,
            "name": "Blimp",
            "resource_uri": "/api/v2/project/50/",
            "slug": "blimp",
            "state": "active",
            "stats": {
                "goals_active": 0,
                "goals_all": 2,
                "goals_done": 1,
                "goals_inactive": 1,
                "goals_review": 0,
                "progress": 50
            },
            "team": [
                "/api/v2/user/2/",
                "/api/v2/user/3/"
            ]
        }
    ]
}

Create a project

Example Request

$ curl https://app.getblimp.com/api/v2/project/ --dump-header - \
    -H "Authorization: ApiKey USERNAME:API_KEY" \
    -H "X_BLIMP_APPID: APPLICATION_ID" \
    -H "X_BLIMP_SECRET: APPLICATION_SECRET"
    -H "Content-Type: application/json" \
    -X POST \
    --data '{"name": "My Example Project", "company": "/api/v2/company/1/", "state": "inactive", "team": ["/api/v2/user/2/", "/api/v2/user/3/"]}'

Example Response

HTTP/1.1 201 CREATED
Content-Type: application/json; charset=utf-8
Date: Wed, 23 Jan 2013 12:39:37 GMT
Location: https://app.getblimp.com/api/v2/project/2112/
Server: gunicorn/0.14.6
strict-transport-security: max-age=31536000; includeSubDomains
Vary: Accept, Cookie
x-content-type-options: nosniff
X-Frame-Options: DENY
X-Ratelimit-Limit: 150
X-RateLimit-Remaining: 142
X-Xss-Protection: 1; mode=block
Content-Length: 470
Connection: keep-alive

{
    "company": "/api/v2/company/1/",
    "date_created": "2013-01-23T12:39:37.084109",
    "date_due": null,
    "date_finished": null,
    "date_modified": "2013-01-23T12:39:37.084173",
    "date_started": null,
    "id": 2112,
    "name": "My Example Project",
    "resource_uri": "/api/v2/project/2112/",
    "slug": "my-example-project",
    "state": "inactive",
    "stats": {
        "goals_active": 0,
        "goals_all": 0,
        "goals_done": 0,
        "goals_inactive": 0,
        "goals_review": 0,
        "progress": 0
    },
    "team": [
        "/api/v2/user/2/",
        "/api/v2/user/3/"
     ]
}

Fields:

date_due

name

date_modified

date_finished

company

state

team

date_started

id

resource_uri