Projects

List available projects

List available projects

GET https://api.usestencil.com/v1/projects

Query Parameters

Name	Type	Description
after	string	Query next result set
before	string	Query previous result set

200

{
    "meta": {
        "next": null,
        "previous": null,
        "total_count": 1
    },
    "results": [
        {
            "created_at": "2021-05-06T07:00:21Z",
            "description": "Test",
            "favorite": false,
            "id": "f2eb2dab-a861-4960-b5f4-d54c61552f7d",
            "name": "Test project",
            "self": "https://api.usestencil.com/api/v1/projects/f2eb2dab-a861-4960-b5f4-d54c61552f7d",
            "templates": "https://api.usestencil.com/api/v1/projects/f2eb2dab-a861-4960-b5f4-d54c61552f7d/templates",
            "updated_at": "2021-05-06T07:00:21Z"
        }
    ]
}

after and before are related to pagination. Please see pagination page for more information

The response usually include link to other related endpoints.

self links to detail regarding the resource itself.

templates links to endpoint to list templates related to the project.

Get specific project

GET https://api.usestencil.com/v1/projects/:id

Path Parameters

Name	Type	Description
id	string	Project ID

200

{
    "created_at": "2021-05-06T07:00:21Z",
    "description": "Test",
    "favorite": false,
    "id": "f2eb2dab-a861-4960-b5f4-d54c61552f7d",
    "name": "Test project",
    "self": "https://api.usestencil.com/api/v1/projects/f2eb2dab-a861-4960-b5f4-d54c61552f7d",
    "templates": "https://api.usestencil.com/api/v1/projects/f2eb2dab-a861-4960-b5f4-d54c61552f7d/templates",
    "updated_at": "2021-05-06T07:00:21Z"
}