{"_id":"5696a03fa917c30d0052dc44","excerpt":"","githubsync":"","link_external":false,"parentDoc":null,"updates":[],"__v":15,"createdAt":"2016-01-13T19:06:39.279Z","user":"566b1d1c14c22f1900f00b30","order":0,"project":"566b1ca603b4b20d00d02bd1","type":"basic","version":"566b1ca603b4b20d00d02bd4","category":"56969edfbd07400d007ac0ad","hidden":false,"title":"Introduction","link_url":"","slug":"getting-started-1","sync_unique":"","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"The Waffle API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support [cross-origin resource sharing](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing), allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). [JSON](http://www.json.org/) is returned by all API responses, including errors.\n\n\n\n\n\n\n\n\n\n\n\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"**Please read our [Disclaimer](doc:disclaimer) before using the Waffle API**\"\n}\n[/block]","isReference":false,"childrenPages":[]}

Introduction


The Waffle API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support [cross-origin resource sharing](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing), allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). [JSON](http://www.json.org/) is returned by all API responses, including errors. [block:callout] { "type": "warning", "body": "**Please read our [Disclaimer](doc:disclaimer) before using the Waffle API**" } [/block]
The Waffle API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support [cross-origin resource sharing](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing), allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). [JSON](http://www.json.org/) is returned by all API responses, including errors. [block:callout] { "type": "warning", "body": "**Please read our [Disclaimer](doc:disclaimer) before using the Waffle API**" } [/block]
{"_id":"5696a096bd07400d007ac0b2","excerpt":"","link_url":"","project":"566b1ca603b4b20d00d02bd1","type":"basic","user":"566b1d1c14c22f1900f00b30","hidden":false,"sync_unique":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"","category":"56969ee77596a90d0014e64c","createdAt":"2016-01-13T19:08:06.224Z","githubsync":"","order":0,"title":"Authentication","updates":[],"__v":0,"isReference":false,"link_external":false,"parentDoc":null,"slug":"authentication","version":"566b1ca603b4b20d00d02bd4","childrenPages":[]}
{"_id":"5696a0a0a7bebe0d0007f85e","project":"566b1ca603b4b20d00d02bd1","version":"566b1ca603b4b20d00d02bd4","__v":1,"category":"56969ee77596a90d0014e64c","createdAt":"2016-01-13T19:08:16.295Z","link_external":false,"slug":"errors","title":"Errors","updates":[],"user":"566b1d1c14c22f1900f00b30","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"githubsync":"","parentDoc":null,"excerpt":"","hidden":false,"link_url":"","sync_unique":"","body":"Waffle uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with Waffle's servers.","order":1,"type":"basic","childrenPages":[]}

Errors


Waffle uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with Waffle's servers.
Waffle uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with Waffle's servers.
{"_id":"5696a0b27596a90d0014e650","link_external":false,"order":2,"updates":[],"link_url":"","slug":"pagination","title":"Pagination","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"category":"56969ee77596a90d0014e64c","createdAt":"2016-01-13T19:08:34.255Z","githubsync":"","hidden":false,"project":"566b1ca603b4b20d00d02bd1","version":"566b1ca603b4b20d00d02bd4","__v":2,"body":"Resources in Waffle's API are not pageable. You always get everything!","excerpt":"","parentDoc":null,"sync_unique":"","type":"basic","user":"566b1d1c14c22f1900f00b30","childrenPages":[]}

Pagination


Resources in Waffle's API are not pageable. You always get everything!
Resources in Waffle's API are not pageable. You always get everything!
{"_id":"5696a0bbcb14e11700f8a9ef","link_external":false,"link_url":"","parentDoc":null,"createdAt":"2016-01-13T19:08:43.048Z","excerpt":"","githubsync":"","updates":[],"__v":3,"body":"By default, all requests receive the v1 version of the API. We encourage you to explicitly request this version via the Accept header.\n\n```\nAccept: application/vnd.waffle.v1+json\n```","category":"56969ee77596a90d0014e64c","version":"566b1ca603b4b20d00d02bd4","slug":"versioning","type":"basic","user":"566b1d1c14c22f1900f00b30","api":{"auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"hidden":false,"order":3,"project":"566b1ca603b4b20d00d02bd1","sync_unique":"","title":"Versioning","childrenPages":[]}

Versioning


By default, all requests receive the v1 version of the API. We encourage you to explicitly request this version via the Accept header. ``` Accept: application/vnd.waffle.v1+json ```
By default, all requests receive the v1 version of the API. We encourage you to explicitly request this version via the Accept header. ``` Accept: application/vnd.waffle.v1+json ```
{"_id":"56a114d73697d80d002ac687","project":"566b1ca603b4b20d00d02bd1","title":"User","updates":[],"sync_unique":"","version":"566b1ca603b4b20d00d02bd4","__v":7,"api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]}},"excerpt":"","hidden":false,"parentDoc":null,"user":"566b1c7285fbc81700f894e5","body":"A `user` object represents a logged in user. Waffle does not expose users publicly, unlike GitHub. To view a user object you need an access token.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Attributes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Value (Example)\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`_id`\",\n    \"0-1\": \"`536bafa8ebef97b1f959bd99`\",\n    \"0-2\": \"The unique identifier for this user.\",\n    \"1-0\": \"`account`\",\n    \"1-1\": \"`53c60257ce55420200f6ba13`\",\n    \"1-2\": \"The id of this user's [account](https://dash.readme.io/project/waffleio/v1.0/docs/accounts).\",\n    \"2-0\": \"`github`\",\n    \"2-1\": \"```\\n{\\n  \\\"login\\\": \\\"waffle-iron\\\",\\n  \\\"email\\\": \\\"iron@waffle.io\\\",\\n  \\\"name\\\": \\\"Waffle Iron\\\",\\n  \\\"avatar_url\\\": \\\"https://avatars.githubusercontent.com/u/4775781?v=3\\\"\\n  }\\n```\",\n    \"2-2\": \"The GitHub profile information for the user.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","category":"56a11479842b650d008888b0","createdAt":"2016-01-21T17:26:47.002Z","order":0,"type":"basic","githubsync":"","link_external":false,"link_url":"","slug":"user","childrenPages":[]}

User


A `user` object represents a logged in user. Waffle does not expose users publicly, unlike GitHub. To view a user object you need an access token. [block:api-header] { "type": "basic", "title": "Attributes" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Value (Example)", "h-2": "Description", "0-0": "`_id`", "0-1": "`536bafa8ebef97b1f959bd99`", "0-2": "The unique identifier for this user.", "1-0": "`account`", "1-1": "`53c60257ce55420200f6ba13`", "1-2": "The id of this user's [account](https://dash.readme.io/project/waffleio/v1.0/docs/accounts).", "2-0": "`github`", "2-1": "```\n{\n \"login\": \"waffle-iron\",\n \"email\": \"iron@waffle.io\",\n \"name\": \"Waffle Iron\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/4775781?v=3\"\n }\n```", "2-2": "The GitHub profile information for the user." }, "cols": 3, "rows": 3 } [/block]
A `user` object represents a logged in user. Waffle does not expose users publicly, unlike GitHub. To view a user object you need an access token. [block:api-header] { "type": "basic", "title": "Attributes" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Value (Example)", "h-2": "Description", "0-0": "`_id`", "0-1": "`536bafa8ebef97b1f959bd99`", "0-2": "The unique identifier for this user.", "1-0": "`account`", "1-1": "`53c60257ce55420200f6ba13`", "1-2": "The id of this user's [account](https://dash.readme.io/project/waffleio/v1.0/docs/accounts).", "2-0": "`github`", "2-1": "```\n{\n \"login\": \"waffle-iron\",\n \"email\": \"iron@waffle.io\",\n \"name\": \"Waffle Iron\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/4775781?v=3\"\n }\n```", "2-2": "The GitHub profile information for the user." }, "cols": 3, "rows": 3 } [/block]
{"_id":"566b1ca803b4b20d00d02bd7","excerpt":"Fetch the current user","hidden":false,"link_url":"","slug":"getting-started","version":"566b1ca603b4b20d00d02bd4","githubsync":"","title":"/user","updates":[],"__v":95,"api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_id\": \"53244220b728ed1d0009af87\",\n  \"account\": \"56254220b728ed1d0009af89\",\n  \"github\": {\n    \"login\": \"waffle-iron\",\n    \"email\": \"iron@waffle.io\",\n    \"name\": \"Waffle Iron\",\n    \"avatar_url\": \"https://avatars.githubusercontent.com/u/4775781?v=3\"\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/user"},"parentDoc":null,"project":"566b1ca603b4b20d00d02bd1","sync_unique":"","type":"get","body":"Sending a `GET` to `/user` fetches the current user.","category":"56a11479842b650d008888b0","createdAt":"2015-12-11T18:57:44.811Z","link_external":false,"order":1,"user":"566b1c7285fbc81700f894e5","childrenPages":[]}

get/user

Fetch the current user

Sending a `GET` to `/user` fetches the current user.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Sending a `GET` to `/user` fetches the current user.
{"_id":"56a114e5842b650d008888b2","parentDoc":null,"sync_unique":"","version":"566b1ca603b4b20d00d02bd4","link_url":"","type":"basic","updates":[],"hidden":false,"isReference":false,"link_external":false,"order":0,"title":"Projects","createdAt":"2016-01-21T17:27:01.819Z","excerpt":"","githubsync":"","user":"566b1c7285fbc81700f894e5","body":"A `project` object represents a Waffle board. Meta information about your project is stored directly on the object, including team members, viewers, and sources.\n\nA `source` represents a repository that you've added to your project. The first `source` in your list is the primary repository, which is also the name of your project. Any other sources are secondary repos that show on your board.\n\nThe `team` list is all the users that are collaborators on this project. Before adding someone to the team list, Waffle checks to make sure they're a collaborator on the primary source. If someone is in the team list, they can see all the cards in the project. If a project includes public and private sources, Waffle verifies the current user has private `repo` scope for their access token before showing cards from private sources. But, if a user is a collaborator on a private primary source, but not on a private secondary source, they will still see cards from the secondary source, but they will not be able to make any updates to them.\n\nAnyone in the `team` list can also edit project settings.\n\nThe `viewers` list is all the users that have \"pull\" access only (read only) to a primary source.\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Attributes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Value (Example)\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`_id`\",\n    \"0-1\": \"`55cdf1333ff3741000c04645`\",\n    \"0-2\": \"The unique identifier for this user.\",\n    \"1-0\": \"`account`\",\n    \"1-1\": \"`55cd022d5d36c52900f05480`\",\n    \"1-2\": \"The id of this user's [Account](doc:accounts) that owns this project.\",\n    \"2-0\": \"`name`\",\n    \"2-1\": \"`waffle-maker/waffle-recipe`\",\n    \"2-2\": \"The name of the primary source, and hence the name of the project.\",\n    \"5-0\": \"`source.private`\",\n    \"5-1\": \"`false`\",\n    \"5-2\": \"Whether the repo is private or not.\",\n    \"4-0\": \"`source.provider`\",\n    \"4-1\": \"`5399ba229c4ef5963e000508`\",\n    \"4-2\": \"A reference to the [Provider](doc:providers) of the source.\",\n    \"3-0\": \"`sources`\",\n    \"3-1\": \"```\\n[{\\n  \\\"provider\\\": \\\"5399ba229c4ef5963e000508\\\",\\n  \\\"_id\\\": \\\"55cdf1333ff3741000c04646\\\",\\n  \\\"hooked\\\": true,\\n  \\\"synced\\\": true,\\n  \\\"private\\\": false,\\n  \\\"repoPath\\\": \\\"waffle-maker/waffle-recipe\\\",\\n  \\\"type\\\": \\\"github\\\"\\n}]\\n```\",\n    \"3-2\": \"The list of repositories that are configured on this board.\",\n    \"6-0\": \"`source.hooked`\",\n    \"6-1\": \"`true`\",\n    \"6-2\": \"Whether or not Waffle was able to configure a webhook for the source. If this is false, Waffle will prompt users to create a webhook.\",\n    \"7-0\": \"`source.repoPath`\",\n    \"7-1\": \"`waffle-maker/waffle-recipe`\",\n    \"7-2\": \"The path to the repository in GitHub.\",\n    \"8-0\": \"`source.type`\",\n    \"8-1\": \"`github`\",\n    \"8-2\": \"Either `github` or `github enterprise`, depending on where the repository lives.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]","category":"56a1148e842b650d008888b1","project":"566b1ca603b4b20d00d02bd1","slug":"project","__v":15,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"childrenPages":[]}

Projects


A `project` object represents a Waffle board. Meta information about your project is stored directly on the object, including team members, viewers, and sources. A `source` represents a repository that you've added to your project. The first `source` in your list is the primary repository, which is also the name of your project. Any other sources are secondary repos that show on your board. The `team` list is all the users that are collaborators on this project. Before adding someone to the team list, Waffle checks to make sure they're a collaborator on the primary source. If someone is in the team list, they can see all the cards in the project. If a project includes public and private sources, Waffle verifies the current user has private `repo` scope for their access token before showing cards from private sources. But, if a user is a collaborator on a private primary source, but not on a private secondary source, they will still see cards from the secondary source, but they will not be able to make any updates to them. Anyone in the `team` list can also edit project settings. The `viewers` list is all the users that have "pull" access only (read only) to a primary source. [block:api-header] { "type": "basic", "title": "Attributes" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Value (Example)", "h-2": "Description", "0-0": "`_id`", "0-1": "`55cdf1333ff3741000c04645`", "0-2": "The unique identifier for this user.", "1-0": "`account`", "1-1": "`55cd022d5d36c52900f05480`", "1-2": "The id of this user's [Account](doc:accounts) that owns this project.", "2-0": "`name`", "2-1": "`waffle-maker/waffle-recipe`", "2-2": "The name of the primary source, and hence the name of the project.", "5-0": "`source.private`", "5-1": "`false`", "5-2": "Whether the repo is private or not.", "4-0": "`source.provider`", "4-1": "`5399ba229c4ef5963e000508`", "4-2": "A reference to the [Provider](doc:providers) of the source.", "3-0": "`sources`", "3-1": "```\n[{\n \"provider\": \"5399ba229c4ef5963e000508\",\n \"_id\": \"55cdf1333ff3741000c04646\",\n \"hooked\": true,\n \"synced\": true,\n \"private\": false,\n \"repoPath\": \"waffle-maker/waffle-recipe\",\n \"type\": \"github\"\n}]\n```", "3-2": "The list of repositories that are configured on this board.", "6-0": "`source.hooked`", "6-1": "`true`", "6-2": "Whether or not Waffle was able to configure a webhook for the source. If this is false, Waffle will prompt users to create a webhook.", "7-0": "`source.repoPath`", "7-1": "`waffle-maker/waffle-recipe`", "7-2": "The path to the repository in GitHub.", "8-0": "`source.type`", "8-1": "`github`", "8-2": "Either `github` or `github enterprise`, depending on where the repository lives." }, "cols": 3, "rows": 9 } [/block]
A `project` object represents a Waffle board. Meta information about your project is stored directly on the object, including team members, viewers, and sources. A `source` represents a repository that you've added to your project. The first `source` in your list is the primary repository, which is also the name of your project. Any other sources are secondary repos that show on your board. The `team` list is all the users that are collaborators on this project. Before adding someone to the team list, Waffle checks to make sure they're a collaborator on the primary source. If someone is in the team list, they can see all the cards in the project. If a project includes public and private sources, Waffle verifies the current user has private `repo` scope for their access token before showing cards from private sources. But, if a user is a collaborator on a private primary source, but not on a private secondary source, they will still see cards from the secondary source, but they will not be able to make any updates to them. Anyone in the `team` list can also edit project settings. The `viewers` list is all the users that have "pull" access only (read only) to a primary source. [block:api-header] { "type": "basic", "title": "Attributes" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Value (Example)", "h-2": "Description", "0-0": "`_id`", "0-1": "`55cdf1333ff3741000c04645`", "0-2": "The unique identifier for this user.", "1-0": "`account`", "1-1": "`55cd022d5d36c52900f05480`", "1-2": "The id of this user's [Account](doc:accounts) that owns this project.", "2-0": "`name`", "2-1": "`waffle-maker/waffle-recipe`", "2-2": "The name of the primary source, and hence the name of the project.", "5-0": "`source.private`", "5-1": "`false`", "5-2": "Whether the repo is private or not.", "4-0": "`source.provider`", "4-1": "`5399ba229c4ef5963e000508`", "4-2": "A reference to the [Provider](doc:providers) of the source.", "3-0": "`sources`", "3-1": "```\n[{\n \"provider\": \"5399ba229c4ef5963e000508\",\n \"_id\": \"55cdf1333ff3741000c04646\",\n \"hooked\": true,\n \"synced\": true,\n \"private\": false,\n \"repoPath\": \"waffle-maker/waffle-recipe\",\n \"type\": \"github\"\n}]\n```", "3-2": "The list of repositories that are configured on this board.", "6-0": "`source.hooked`", "6-1": "`true`", "6-2": "Whether or not Waffle was able to configure a webhook for the source. If this is false, Waffle will prompt users to create a webhook.", "7-0": "`source.repoPath`", "7-1": "`waffle-maker/waffle-recipe`", "7-2": "The path to the repository in GitHub.", "8-0": "`source.type`", "8-1": "`github`", "8-2": "Either `github` or `github enterprise`, depending on where the repository lives." }, "cols": 3, "rows": 9 } [/block]
{"_id":"5696a0ee31f5c30d006235b7","body":"Fetch the list of projects that a user belongs to. \n\nA user will be in the `team` or the `viewers` list for each project in the response.","parentDoc":null,"sync_unique":"","api":{"params":[],"results":{"codes":[{"status":200,"name":"","code":"[{\n  \"_id\": \"55cdf1333ff3741000c04645\",\n  \"account\": \"55cd022d5d36c52900f05480\",\n  \"name\": \"waffle-maker/waffle-recipe\",\n  \"viewers\": [],\n  \"team\": [\n    \"55cd022d5d36c52900f0547e\"\n  ],\n  \"integrations\": [],\n  \"sources\": [\n    {\n      \"provider\": {\n        \"_id\": \"5399ba229c4ef5963e000508\",\n        \"type\": \"github\",\n        \"baseApiUrl\": \"https://api.github.com\",\n        \"baseUrl\": \"https://github.com\",\n        \"clientId\": \"b68f04bdff231220a275\",\n        \"default\": true,\n        \"public\": true\n      },\n      \"_id\": \"55cdf1333ff3741000c04646\",\n      \"hooked\": true,\n      \"synced\": true,\n      \"private\": false,\n      \"repoPath\": \"waffle-maker/waffle-recipe\",\n      \"type\": \"github\"\n    }\n  ]","language":"json"}]},"settings":"","url":"/user/projects","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Content-Type: application/json\" https://api.waffle.io/user/projects?access_token=<access token>"}]},"method":"get"},"category":"56a1148e842b650d008888b1","hidden":false,"link_external":false,"link_url":"","project":"566b1ca603b4b20d00d02bd1","user":"566b1d1c14c22f1900f00b30","createdAt":"2016-01-13T19:09:34.431Z","githubsync":"","isReference":false,"order":1,"slug":"projects","__v":15,"excerpt":"","title":"/user/projects","type":"get","updates":[],"version":"566b1ca603b4b20d00d02bd4","childrenPages":[]}

get/user/projects


Fetch the list of projects that a user belongs to. A user will be in the `team` or the `viewers` list for each project in the response.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Fetch the list of projects that a user belongs to. A user will be in the `team` or the `viewers` list for each project in the response.
{"_id":"56a11532c29eb50d00e33e86","body":"Fetch a specific project by `id`. \n\nAuthentication is required for private projects, not required for public projects.","createdAt":"2016-01-21T17:28:18.066Z","link_url":"","parentDoc":null,"project":"566b1ca603b4b20d00d02bd1","user":"566b1c7285fbc81700f894e5","__v":10,"excerpt":"","hidden":false,"order":2,"sync_unique":"","updates":[],"type":"get","version":"566b1ca603b4b20d00d02bd4","api":{"results":{"codes":[{"name":"","code":"{\n  \"_id\": \"55cdf1333ff3741000c04645\",\n  \"account\": \"55cd022d5d36c52900f05480\",\n  \"name\": \"waffle-maker/waffle-recipe\",\n  \"viewers\": [],\n  \"team\": [\n    \"55cd022d5d36c52900f0547e\"\n  ],\n    \"sources\": [\n    {\n      \"provider\": {\n        \"_id\": \"5399ba229c4ef5963e000508\",\n        \"type\": \"github\",\n        \"baseApiUrl\": \"https://api.github.com\",\n        \"baseUrl\": \"https://github.com\",\n        \"clientId\": \"b68f04bdff231220a275\",\n        \"default\": true,\n        \"public\": true\n      },\n      \"_id\": \"55cdf1333ff3741000c04646\",\n      \"hooked\": true,\n      \"synced\": true,\n      \"private\": false,\n      \"repoPath\": \"waffle-maker/waffle-recipe\",\n      \"type\": \"github\"\n    }\n  ]","language":"json","status":200}]},"settings":"","url":"/project/:id","auth":"optional","examples":{"codes":[{"code":"curl -X GET -H \"Content-Type: application/json\" https://api.waffle.io/project/:id?access_token=<access token>","language":"curl"}]},"method":"get","params":[]},"githubsync":"","isReference":false,"slug":"projectid","title":"/project/:id","category":"56a1148e842b650d008888b1","link_external":false,"next":{"description":"","pages":[]},"childrenPages":[]}

get/project/:id


Fetch a specific project by `id`. Authentication is required for private projects, not required for public projects.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Fetch a specific project by `id`. Authentication is required for private projects, not required for public projects.
{"_id":"56a11e65d847b50d00a2768c","order":3,"type":"get","user":"566b1c7285fbc81700f894e5","link_external":false,"link_url":"","excerpt":"","sync_unique":"","title":"/projects/:owner/:repo","version":"566b1ca603b4b20d00d02bd4","api":{"params":[{"type":"string","in":"path","_id":"56e1e6e1059d4a0e0034fa42","default":"","desc":"The GitHub repo owner","name":"owner","ref":"","required":false},{"default":"","type":"string","name":"repo","in":"path","_id":"56e1e6e1059d4a0e0034fa41","ref":"","required":false,"desc":"The name of the GitHub repo"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_id\": \"55cdf1333ff3741000c04645\",\n  \"account\": \"55cd022d5d36c52900f05480\",\n  \"name\": \"waffle-maker/waffle-recipe\",\n  \"viewers\": [],\n  \"team\": [\n    \"55cd022d5d36c52900f0547e\",\n  ],\n  \"integrations\": [],\n  \"sources\": [\n    {\n      \"provider\": {\n        \"_id\": \"5399ba229c4ef5963e000508\",\n        \"type\": \"github\",\n        \"baseApiUrl\": \"https://api.github.com\",\n        \"baseUrl\": \"https://github.com\",\n        \"clientId\": \"b68f04bdff231220a275\",\n        \"default\": true,\n        \"public\": true\n      },\n      \"_id\": \"55cdf1333ff3741000c04646\",\n      \"hooked\": true,\n      \"synced\": true,\n      \"private\": false,\n      \"repoPath\": \"waffle-maker/waffle-recipe\",\n      \"type\": \"github\"\n    }\n  ]","name":""}]},"settings":"","url":"/projects/:owner/:repo","auth":"optional","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Content-Type: application/json\" https://api.waffle.io/projects/:owner/:repo?access_token=<access token>"}]},"method":"get"},"body":"Fetch a specific repo by owner and repo name.","createdAt":"2016-01-21T18:07:33.414Z","updates":[],"editedParams":true,"parentDoc":null,"project":"566b1ca603b4b20d00d02bd1","githubsync":"","hidden":false,"isReference":false,"slug":"projectsownerrepo","__v":3,"category":"56a1148e842b650d008888b1","editedParams2":true,"childrenPages":[]}

get/projects/:owner/:repo


Path Params

owner:
string
The GitHub repo owner
repo:
string
The name of the GitHub repo
Fetch a specific repo by owner and repo name.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Fetch a specific repo by owner and repo name.
{"_id":"56a115428b2e6f0d0018e976","createdAt":"2016-01-21T17:28:34.435Z","hidden":false,"version":"566b1ca603b4b20d00d02bd4","__v":6,"body":"Create a new project from a repo in GitHub.\n\nSend the name of the repo as json:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"name\\\": \\\"waffle-maker/waffle-cookbook\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","parentDoc":null,"project":"566b1ca603b4b20d00d02bd1","slug":"projects-1","sync_unique":"","user":"566b1c7285fbc81700f894e5","isReference":false,"order":4,"link_url":"","updates":[],"excerpt":"","githubsync":"","category":"56a1148e842b650d008888b1","link_external":false,"title":"/projects","type":"post","api":{"url":"/projects","auth":"required","examples":{"codes":[{"code":"curl -X POST -d '{\"name\":\"waffle-maker/waffle-cookbook\"}' -H \"Content-Type: application/json\" https://api.waffle.io/projects?access_token=<access token>","language":"curl"}]},"method":"post","params":[],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"account\": \"56241220b728ed1d0009af89\",\n  \"name\": \"waffle-maker/waffle-recipe\",\n  \"_id\": \"56e1eaacbdedd85b0146de17\",\n  \"viewers\": [],\n  \"team\": [\n    \"56241220b728ed1d0009af87\"\n  ],\n  \"integrations\": [],\n  \"sources\": [\n    {\n      \"provider\": {\n        \"_id\": \"5399ba229c4ef5963e000508\",\n        \"type\": \"github\",\n        \"baseApiUrl\": \"https://api.github.com\",\n        \"baseUrl\": \"https://github.com\",\n        \"clientId\": \"b68f04bdff231220a275\",\n        \"default\": true,\n        \"public\": true\n      },\n      \"_id\": \"56e1eaacbdedd85b0146de18\",\n      \"hooked\": true,\n      \"synced\": false,\n      \"private\": false,\n      \"repoPath\": \"waffle-maker/waffle-cookbook\",\n      \"type\": \"github\"\n    }\n  ]\n}","name":""}]},"settings":""},"childrenPages":[]}

post/projects


Create a new project from a repo in GitHub. Send the name of the repo as json: [block:code] { "codes": [ { "code": "{\n \"name\": \"waffle-maker/waffle-cookbook\"\n}", "language": "json" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Create a new project from a repo in GitHub. Send the name of the repo as json: [block:code] { "codes": [ { "code": "{\n \"name\": \"waffle-maker/waffle-cookbook\"\n}", "language": "json" } ] } [/block]
{"_id":"56a1156bc29eb50d00e33e88","createdAt":"2016-01-21T17:29:15.137Z","project":"566b1ca603b4b20d00d02bd1","updates":[],"__v":4,"slug":"projectsid-2","type":"delete","excerpt":"","link_external":false,"link_url":"","order":6,"parentDoc":null,"sync_unique":"","title":"/projects/:id","user":"566b1c7285fbc81700f894e5","body":"Deletes a project using `id`. This will not delete any associated GitHub repositories or issues. You will however, lose any Waffle specific data like issue sizing and column configuration.","version":"566b1ca603b4b20d00d02bd4","api":{"examples":{"codes":[{"language":"curl","code":"curl -X DEL -H \"Content-Type: application/json\" https://api.waffle.io/projects/:id?access_token=<access token>"}]},"method":"delete","params":[],"results":{"codes":[{"name":"","status":204,"language":"json","code":""}]},"settings":"","url":"/projects/:id","auth":"required"},"category":"56a1148e842b650d008888b1","githubsync":"","hidden":false,"isReference":false,"childrenPages":[]}

delete/projects/:id


Deletes a project using `id`. This will not delete any associated GitHub repositories or issues. You will however, lose any Waffle specific data like issue sizing and column configuration.

Definition

{{ api_url }}{{ page_api_url }}

Examples



Deletes a project using `id`. This will not delete any associated GitHub repositories or issues. You will however, lose any Waffle specific data like issue sizing and column configuration.
{"_id":"56a11ddce7056c170060b94f","excerpt":"","link_external":false,"link_url":"","__v":12,"api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_id\": \"55cdf1333ff3741000c04645\",\n  \"account\": \"55cd022d5d36c52900f05480\",\n  \"name\": \"waffle-maker/waffle-recipe\",\n  \"viewers\": [],\n  \"team\": [\n    \"55cd022d5d36c52900f0547e\"\n  ],\n  \"sources\": [\n    {\n      \"provider\": {\n        \"_id\": \"5399ba229c4ef5963e000508\",\n        \"type\": \"github\",\n        \"baseApiUrl\": \"https://api.github.com\",\n        \"baseUrl\": \"https://github.com\",\n        \"clientId\": \"b68f04bdff231220a275\",\n        \"default\": true,\n        \"public\": true\n      },\n      \"_id\": \"55cdf1333ff3741000c04646\",\n      \"hooked\": true,\n      \"synced\": true,\n      \"private\": false,\n      \"repoPath\": \"waffle-maker/waffle-recipe\",\n      \"type\": \"github\"\n    }\n  ]\n}","name":""}]},"settings":"","url":"/projects/:id/sources","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X POST -d '{\"provider\": \"5399ba229c4ef5963e000508\", \"private\": false, \"repoPath\": \"waffle-maker/waffle-cookbook\", \"type\":\"github\"}' -H \"Content-Type: application/json\" https://api.waffle.io/projects/:id/sources?access_token=<access token>"}]},"method":"post"},"body":"A `source` is a GitHub repository attached to a project (board). A `POST` will add a GitHub repo to your project.\n\nThese four parameters are required, as JSON:\n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"provider\\\": \\\"5399ba229c4ef5963e000508\\\",\\n    \\\"private\\\": false,\\n    \\\"repoPath\\\": \\\"waffle-maker/waffle-cookbook\\\",\\n    \\\"type\\\": \\\"github\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","category":"56a1148e842b650d008888b1","slug":"projectsidsources","type":"post","title":"/projects/:id/sources","hidden":false,"order":7,"parentDoc":null,"project":"566b1ca603b4b20d00d02bd1","sync_unique":"","createdAt":"2016-01-21T18:05:16.966Z","githubsync":"","isReference":false,"updates":[],"user":"566b1c7285fbc81700f894e5","version":"566b1ca603b4b20d00d02bd4","childrenPages":[]}

post/projects/:id/sources


A `source` is a GitHub repository attached to a project (board). A `POST` will add a GitHub repo to your project. These four parameters are required, as JSON: [block:code] { "codes": [ { "code": "{\n \"provider\": \"5399ba229c4ef5963e000508\",\n \"private\": false,\n \"repoPath\": \"waffle-maker/waffle-cookbook\",\n \"type\": \"github\"\n}", "language": "json" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



A `source` is a GitHub repository attached to a project (board). A `POST` will add a GitHub repo to your project. These four parameters are required, as JSON: [block:code] { "codes": [ { "code": "{\n \"provider\": \"5399ba229c4ef5963e000508\",\n \"private\": false,\n \"repoPath\": \"waffle-maker/waffle-cookbook\",\n \"type\": \"github\"\n}", "language": "json" } ] } [/block]
{"_id":"56a11e0dc29eb50d00e33e8f","user":"566b1c7285fbc81700f894e5","isReference":false,"link_external":false,"type":"put","updates":[],"__v":13,"createdAt":"2016-01-21T18:06:05.356Z","excerpt":"","githubsync":"","project":"566b1ca603b4b20d00d02bd1","slug":"projectsidsourcesid","title":"/projects/:id/sources/:id","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X PUT -d '{\"displayName\": \"waffle-cookbook\"}' -H \"Content-Type: application/json\" https://api.waffle.io/projects/:id/sources?access_token=<access token>"}]},"method":"put","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_id\": \"55cdf1333ff3741000c04645\",\n  \"account\": \"55cd022d5d36c52900f05480\",\n  \"name\": \"waffle-maker/waffle-recipe\",\n  \"viewers\": [],\n  \"team\": [\n    \"55cd022d5d36c52900f0547e\",\n  ],\n  \"integrations\": [],\n  \"sources\": [\n    {\n      \"provider\": {\n        \"_id\": \"5399ba229c4ef5963e000508\",\n        \"type\": \"github\",\n        \"baseApiUrl\": \"https://api.github.com\",\n        \"baseUrl\": \"https://github.com\",\n        \"clientId\": \"b68f04bdff231220a275\",\n        \"default\": true,\n        \"public\": true\n      },\n      \"_id\": \"55cdf1333ff3741000c04646\",\n      \"hooked\": true,\n      \"synced\": true,\n      \"private\": false,\n      \"repoPath\": \"waffle-maker/waffle-recipe\",\n      \"type\": \"github\",\n      \"displayName\": \"waffle-cookbook\"\n    }\n  ]\n}","name":""}]},"settings":"","url":"/projects/:id/sources/:id"},"category":"56a1148e842b650d008888b1","link_url":"","order":8,"parentDoc":null,"sync_unique":"","version":"566b1ca603b4b20d00d02bd4","body":"This is how you edit a source on a project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"displayName\\\": \\\"waffle-cookbook\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nYou can only update the display name on a source right now.","hidden":false,"childrenPages":[]}

put/projects/:id/sources/:id


This is how you edit a source on a project. [block:code] { "codes": [ { "code": "{\n \"displayName\": \"waffle-cookbook\"\n}", "language": "json" } ] } [/block] You can only update the display name on a source right now.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is how you edit a source on a project. [block:code] { "codes": [ { "code": "{\n \"displayName\": \"waffle-cookbook\"\n}", "language": "json" } ] } [/block] You can only update the display name on a source right now.
{"_id":"56a11e1ee7056c170060b951","project":"566b1ca603b4b20d00d02bd1","sync_unique":"","title":"/projects/:id/sources/:id","updates":[],"category":"56a1148e842b650d008888b1","createdAt":"2016-01-21T18:06:22.026Z","api":{"params":[],"results":{"codes":[{"language":"json","status":204,"name":"","code":""}]},"settings":"","url":"/projects/:id/sources/:id","auth":"required","examples":{"codes":[{"code":"curl -X DEL -H \"Content-Type: application/json\" https://api.waffle.io/projects/:id/sources/:id?access_token=<access token>","language":"curl"}]},"method":"delete"},"body":"This is how you delete a source from a project. This will not delete any associated GitHub repositories or issues.\n\nYou're not able to delete the primary (first) source.","hidden":false,"link_external":false,"order":9,"parentDoc":null,"__v":9,"slug":"projectsidsourcesid-1","githubsync":"","user":"566b1c7285fbc81700f894e5","link_url":"","type":"delete","version":"566b1ca603b4b20d00d02bd4","excerpt":"","isReference":false,"childrenPages":[]}

delete/projects/:id/sources/:id


This is how you delete a source from a project. This will not delete any associated GitHub repositories or issues. You're not able to delete the primary (first) source.

Definition

{{ api_url }}{{ page_api_url }}

Examples



This is how you delete a source from a project. This will not delete any associated GitHub repositories or issues. You're not able to delete the primary (first) source.
{"_id":"56a1502e9d5a3f19001db63c","link_url":"","slug":"cards-1","title":"Cards","version":"566b1ca603b4b20d00d02bd4","excerpt":"","isReference":false,"sync_unique":"","user":"566b1c7285fbc81700f894e5","__v":20,"api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required"},"category":"56a11ef0c29eb50d00e33e92","githubsync":"","parentDoc":null,"project":"566b1ca603b4b20d00d02bd1","type":"basic","updates":[],"createdAt":"2016-01-21T21:39:58.579Z","hidden":false,"link_external":false,"order":0,"body":"A `card` object represents an issue on a Waffle board. Why do we call it a card? Well, it's a bit more than just the GitHub Issue. Waffle keeps track of the card's size, for example. The card keeps everything about the actual GitHub Issue in the `githubMetadata` property, but we tack on a few other things that's Waffle specific.\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Attributes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Value (Example)\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"`56fc51a4b964f4710073cece`\",\n    \"0-2\": \"The unique identifier for this card.\",\n    \"1-0\": \"`project`\",\n    \"1-1\": \"`55cd022d5d36c52900f05480`\",\n    \"1-2\": \"The project id that the card belongs to.\",\n    \"2-0\": \"`githubMetadata`\",\n    \"2-1\": \"```\\n{\\n      \\\"id\\\": 132527550,\\n      \\\"created_at\\\": \\\"2016-02-09T20:42:25.000Z\\\",\\n      \\\"closed_at\\\": \\\"1970-01-01T00:00:00.000Z\\\",\\n      \\\"updated_at\\\": \\\"2016-03-30T22:05:15.000Z\\\",\\n      \\\"number\\\": 30,\\n      \\\"state\\\": \\\"open\\\",\\n      \\\"title\\\": \\\"Add section for waffle maker maintenance for you\\\",\\n      \\\"url\\\": \\\"https://api.github.com/repos/waffle-maker/waffle-recipe/issues/30\\\",\\n      \\\"html_url\\\": \\\"https://github.com/waffle-maker/waffle-recipe/issues/30\\\",\\n      \\\"comments\\\": 2,\\n      \\\"source\\\": \\\"55cdf1333ff3741000c04646\\\",\\n      \\\"milestone\\\": {\\n        \\\"id\\\": 1573383,\\n        \\\"number\\\": 6,\\n        \\\"title\\\": \\\"Waffle maker repair \\\"\\n}\\n```\",\n    \"2-2\": \"The GitHub Issue information. Waffle also connects the issue to the correct `source`, or GitHub repo, under `githubMetadata.source`.\",\n    \"3-0\": \"`labels`\",\n    \"3-1\": \"```\\n [{\\n    \\\"name\\\": \\\"backlog\\\",\\n    \\\"color\\\": \\\"e6e6e6\\\"\\n}, {\\n    \\\"name\\\": \\\"bug\\\",\\n    \\\"color\\\": \\\"db4638\\\"\\n}]\\n```\",\n    \"3-2\": \"The name and color of the labels on a card.\",\n    \"4-0\": \"`assignee`\",\n    \"4-1\": \"```\\n{\\n        \\\"login\\\": \\\"waffle-maker\\\",\\n        \\\"avatar_url\\\": \\\"https://avatars.githubusercontent.com/u/100216?v=3\\\"\\n}\\n```\",\n    \"4-2\": \"The GitHub user that is assigned to that issue.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\nHere are a few common 'How To' actions for cards:\n\n## How to rank cards:\n\n\nTo rank cards, you'll use a PUT request to update a card's `rank`. To move a card to the top of a column, you'll update `rank` to `top`. To move a card to the bottom of the column, you'll update `rank` to `bottom`. You can also move cards within the column to different ranks by using a `PUT` request to update `rank` to `above` or `below` a certain card using that card's `_id`.\n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X PUT -H 'Content-Type: application/json' -d '{\\\"githubMetadata\\\": {\\\"body\\\": \\\"will need additional collaborators\\\", \\\"labels\\\": [], \\\"milestone\\\": null, \\\"source\\\": \\\"55cdf1333ff3741000c04646\\\", \\\"title\\\": \\\"how we can make engineering teams love Waffles even more?\\\", \\\"number\\\": 58}, \\\"rank\\\": {\\\"above\\\": \\\"56fc49691660ae1d00317ae7\\\"}}' https://api.waffle.io/cards/:id?access_token=<access token>\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n## How to move a card between columns: \n\n\nTo move cards from one column to another, you'll use a PUT request to change the column label on the card. \n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X PUT -H 'Content-Type: application/json' -d '{\\\"githubMetadata\\\": {\\\"labels\\\": [\\\"ready\\\"]}}' https://api.waffle.io/cards/:id?access_token=<access token>  \",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nAll of the columns will have a label except for the 'Backlog' and 'Done' column. To move an issue to 'Backlog' you'll update the `labels` on a card to either `\"backlog\"` or an empty array. To move an issue to 'Done', you'll update `state` to `\"closed\"`.\n\n## How to move a card to done: \n\n\nTo move a card to the 'Done' column, you'll use a PUT request to update `state` to `\"closed\"`.\n\n## How to archive cards:\n\n\nTo archive a card, you'll use a PUT request to update change `state` to `\"closed\"` and `\"archived\"` to `true`. Only closed issues can be archived.\n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X PUT -H 'Content-Type: application/json' -d '{\\\"githubMetadata\\\": {\\\"body\\\": \\\"ingredients are needed\\\", \\\"labels\\\": [\\\"ready\\\"], \\\"state\\\": \\\"closed\\\", \\\"milestone\\\": null, \\\"source\\\": \\\"55cdf1333ff3741000c04646\\\", \\\"title\\\": \\\"New issue\\\", \\\"number\\\": 58}, \\\"archived\\\": true}' https://api.waffle.io/cards/:id?access_token=<access token>\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n## How to size cards: \n\n\nTo add a size to a card, you'll use a PUT request to update \"size\".","childrenPages":[]}

Cards


A `card` object represents an issue on a Waffle board. Why do we call it a card? Well, it's a bit more than just the GitHub Issue. Waffle keeps track of the card's size, for example. The card keeps everything about the actual GitHub Issue in the `githubMetadata` property, but we tack on a few other things that's Waffle specific. [block:api-header] { "type": "basic", "title": "Attributes" } [/block] [block:parameters] { "data": { "0-0": "`_id`", "h-0": "Name", "h-1": "Value (Example)", "h-2": "Description", "0-1": "`56fc51a4b964f4710073cece`", "0-2": "The unique identifier for this card.", "1-0": "`project`", "1-1": "`55cd022d5d36c52900f05480`", "1-2": "The project id that the card belongs to.", "2-0": "`githubMetadata`", "2-1": "```\n{\n \"id\": 132527550,\n \"created_at\": \"2016-02-09T20:42:25.000Z\",\n \"closed_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"2016-03-30T22:05:15.000Z\",\n \"number\": 30,\n \"state\": \"open\",\n \"title\": \"Add section for waffle maker maintenance for you\",\n \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/issues/30\",\n \"html_url\": \"https://github.com/waffle-maker/waffle-recipe/issues/30\",\n \"comments\": 2,\n \"source\": \"55cdf1333ff3741000c04646\",\n \"milestone\": {\n \"id\": 1573383,\n \"number\": 6,\n \"title\": \"Waffle maker repair \"\n}\n```", "2-2": "The GitHub Issue information. Waffle also connects the issue to the correct `source`, or GitHub repo, under `githubMetadata.source`.", "3-0": "`labels`", "3-1": "```\n [{\n \"name\": \"backlog\",\n \"color\": \"e6e6e6\"\n}, {\n \"name\": \"bug\",\n \"color\": \"db4638\"\n}]\n```", "3-2": "The name and color of the labels on a card.", "4-0": "`assignee`", "4-1": "```\n{\n \"login\": \"waffle-maker\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/100216?v=3\"\n}\n```", "4-2": "The GitHub user that is assigned to that issue." }, "cols": 3, "rows": 5 } [/block] Here are a few common 'How To' actions for cards: ## How to rank cards: To rank cards, you'll use a PUT request to update a card's `rank`. To move a card to the top of a column, you'll update `rank` to `top`. To move a card to the bottom of the column, you'll update `rank` to `bottom`. You can also move cards within the column to different ranks by using a `PUT` request to update `rank` to `above` or `below` a certain card using that card's `_id`. [block:code] { "codes": [ { "code": "curl -X PUT -H 'Content-Type: application/json' -d '{\"githubMetadata\": {\"body\": \"will need additional collaborators\", \"labels\": [], \"milestone\": null, \"source\": \"55cdf1333ff3741000c04646\", \"title\": \"how we can make engineering teams love Waffles even more?\", \"number\": 58}, \"rank\": {\"above\": \"56fc49691660ae1d00317ae7\"}}' https://api.waffle.io/cards/:id?access_token=<access token>", "language": "curl" } ] } [/block] ## How to move a card between columns: To move cards from one column to another, you'll use a PUT request to change the column label on the card. [block:code] { "codes": [ { "code": "curl -X PUT -H 'Content-Type: application/json' -d '{\"githubMetadata\": {\"labels\": [\"ready\"]}}' https://api.waffle.io/cards/:id?access_token=<access token> ", "language": "curl" } ] } [/block] All of the columns will have a label except for the 'Backlog' and 'Done' column. To move an issue to 'Backlog' you'll update the `labels` on a card to either `"backlog"` or an empty array. To move an issue to 'Done', you'll update `state` to `"closed"`. ## How to move a card to done: To move a card to the 'Done' column, you'll use a PUT request to update `state` to `"closed"`. ## How to archive cards: To archive a card, you'll use a PUT request to update change `state` to `"closed"` and `"archived"` to `true`. Only closed issues can be archived. [block:code] { "codes": [ { "code": "curl -X PUT -H 'Content-Type: application/json' -d '{\"githubMetadata\": {\"body\": \"ingredients are needed\", \"labels\": [\"ready\"], \"state\": \"closed\", \"milestone\": null, \"source\": \"55cdf1333ff3741000c04646\", \"title\": \"New issue\", \"number\": 58}, \"archived\": true}' https://api.waffle.io/cards/:id?access_token=<access token>", "language": "curl" } ] } [/block] ## How to size cards: To add a size to a card, you'll use a PUT request to update "size".
A `card` object represents an issue on a Waffle board. Why do we call it a card? Well, it's a bit more than just the GitHub Issue. Waffle keeps track of the card's size, for example. The card keeps everything about the actual GitHub Issue in the `githubMetadata` property, but we tack on a few other things that's Waffle specific. [block:api-header] { "type": "basic", "title": "Attributes" } [/block] [block:parameters] { "data": { "0-0": "`_id`", "h-0": "Name", "h-1": "Value (Example)", "h-2": "Description", "0-1": "`56fc51a4b964f4710073cece`", "0-2": "The unique identifier for this card.", "1-0": "`project`", "1-1": "`55cd022d5d36c52900f05480`", "1-2": "The project id that the card belongs to.", "2-0": "`githubMetadata`", "2-1": "```\n{\n \"id\": 132527550,\n \"created_at\": \"2016-02-09T20:42:25.000Z\",\n \"closed_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"2016-03-30T22:05:15.000Z\",\n \"number\": 30,\n \"state\": \"open\",\n \"title\": \"Add section for waffle maker maintenance for you\",\n \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/issues/30\",\n \"html_url\": \"https://github.com/waffle-maker/waffle-recipe/issues/30\",\n \"comments\": 2,\n \"source\": \"55cdf1333ff3741000c04646\",\n \"milestone\": {\n \"id\": 1573383,\n \"number\": 6,\n \"title\": \"Waffle maker repair \"\n}\n```", "2-2": "The GitHub Issue information. Waffle also connects the issue to the correct `source`, or GitHub repo, under `githubMetadata.source`.", "3-0": "`labels`", "3-1": "```\n [{\n \"name\": \"backlog\",\n \"color\": \"e6e6e6\"\n}, {\n \"name\": \"bug\",\n \"color\": \"db4638\"\n}]\n```", "3-2": "The name and color of the labels on a card.", "4-0": "`assignee`", "4-1": "```\n{\n \"login\": \"waffle-maker\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/100216?v=3\"\n}\n```", "4-2": "The GitHub user that is assigned to that issue." }, "cols": 3, "rows": 5 } [/block] Here are a few common 'How To' actions for cards: ## How to rank cards: To rank cards, you'll use a PUT request to update a card's `rank`. To move a card to the top of a column, you'll update `rank` to `top`. To move a card to the bottom of the column, you'll update `rank` to `bottom`. You can also move cards within the column to different ranks by using a `PUT` request to update `rank` to `above` or `below` a certain card using that card's `_id`. [block:code] { "codes": [ { "code": "curl -X PUT -H 'Content-Type: application/json' -d '{\"githubMetadata\": {\"body\": \"will need additional collaborators\", \"labels\": [], \"milestone\": null, \"source\": \"55cdf1333ff3741000c04646\", \"title\": \"how we can make engineering teams love Waffles even more?\", \"number\": 58}, \"rank\": {\"above\": \"56fc49691660ae1d00317ae7\"}}' https://api.waffle.io/cards/:id?access_token=<access token>", "language": "curl" } ] } [/block] ## How to move a card between columns: To move cards from one column to another, you'll use a PUT request to change the column label on the card. [block:code] { "codes": [ { "code": "curl -X PUT -H 'Content-Type: application/json' -d '{\"githubMetadata\": {\"labels\": [\"ready\"]}}' https://api.waffle.io/cards/:id?access_token=<access token> ", "language": "curl" } ] } [/block] All of the columns will have a label except for the 'Backlog' and 'Done' column. To move an issue to 'Backlog' you'll update the `labels` on a card to either `"backlog"` or an empty array. To move an issue to 'Done', you'll update `state` to `"closed"`. ## How to move a card to done: To move a card to the 'Done' column, you'll use a PUT request to update `state` to `"closed"`. ## How to archive cards: To archive a card, you'll use a PUT request to update change `state` to `"closed"` and `"archived"` to `true`. Only closed issues can be archived. [block:code] { "codes": [ { "code": "curl -X PUT -H 'Content-Type: application/json' -d '{\"githubMetadata\": {\"body\": \"ingredients are needed\", \"labels\": [\"ready\"], \"state\": \"closed\", \"milestone\": null, \"source\": \"55cdf1333ff3741000c04646\", \"title\": \"New issue\", \"number\": 58}, \"archived\": true}' https://api.waffle.io/cards/:id?access_token=<access token>", "language": "curl" } ] } [/block] ## How to size cards: To add a size to a card, you'll use a PUT request to update "size".
{"_id":"5696a10ea857080d0082e8e4","title":"/:owner/:repo/cards","type":"get","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"_id\": \"55cdf1333ff3741000c04645\",\n    \"project\": \"56e30b47c5e36c2d000e2a7b\",\n    \"size\": 3,\n    \"githubMetadata\": {\n      \"id\": 140258954,\n      \"created_at\": \"2016-03-11T18:14:16.000Z\",\n      \"closed_at\": \"1970-01-01T00:00:00.000Z\",\n      \"updated_at\": \"2016-03-25T18:43:05.000Z\",\n      \"number\": 11,\n      \"state\": \"open\",\n      \"title\": \"ingredients for waffle mix\",\n      \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/issues/11\",\n      \"html_url\": \"https://github.com/waffle-maker/waffle-recipe/issues/11\",\n      \"comments\": 1,\n      \"source\": \"56e30b47c5e36c2d000e2a7c\",\n      \"milestone\": {\n        \"id\": 1666251,\n        \"number\": 1,\n        \"title\": \"Sprint 1\"\n      },\n      \"labels\": [\n        {\n          \"name\": \"help wanted\",\n          \"color\": \"159818\"\n        }\n      ],\n      \"assignee\": {\n        \"avatar_url\": \"https://avatars.githubusercontent.com/u/4735572?v=3\",\n        \"login\": \"waffle-maker\"\n      }\n    }\n}","name":""}]},"settings":"","url":"/:owner/:repo/cards","auth":"required","examples":{"codes":[{"code":"curl -X GET -H \"Content-Type: application/json\" https://api.waffle.io/:owner/:repo/cards?access_token=<access token>","language":"curl"}]},"method":"get","params":[]},"body":"This will show you all of the cards in the project. This will include cards from any secondary source, not just the primary source.","category":"56a11ef0c29eb50d00e33e92","createdAt":"2016-01-13T19:10:06.226Z","link_url":"","sync_unique":"","excerpt":"You can see all of the cards on a board.","githubsync":"","slug":"cards","user":"566b1d1c14c22f1900f00b30","isReference":false,"parentDoc":null,"updates":[],"version":"566b1ca603b4b20d00d02bd4","__v":36,"hidden":false,"link_external":false,"order":1,"project":"566b1ca603b4b20d00d02bd1","childrenPages":[]}

get/:owner/:repo/cards

You can see all of the cards on a board.

This will show you all of the cards in the project. This will include cards from any secondary source, not just the primary source.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will show you all of the cards in the project. This will include cards from any secondary source, not just the primary source.
{"_id":"56a11f1f470ae00d00c305c1","category":"56a11ef0c29eb50d00e33e92","githubsync":"","parentDoc":null,"slug":"projectsidcards","type":"get","user":"566b1c7285fbc81700f894e5","body":"This will show all of the cards on an individual project using a project's `id`.\n\nAuthentication is required for private projects, not required for public projects.","createdAt":"2016-01-21T18:10:39.132Z","isReference":false,"link_external":false,"project":"566b1ca603b4b20d00d02bd1","title":"/projects/:id/cards","version":"566b1ca603b4b20d00d02bd4","api":{"results":{"codes":[{"code":"{\n    \"_id\": \"56ba4eef61ec5428004a292f\",\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"size\": 5,\n    \"githubMetadata\": {\n      \"id\": 132527273,\n      \"created_at\": \"2016-02-09T20:41:19.000Z\",\n      \"closed_at\": \"1970-01-01T00:00:00.000Z\",\n      \"updated_at\": \"2016-03-25T19:55:48.000Z\",\n      \"number\": 29,\n      \"state\": \"open\",\n      \"title\": \"Update blog post\",\n      \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/issues/29\",\n      \"html_url\": \"https://github.com/waffle-maker/waffle-recipe/issues/29\",\n      \"comments\": 0,\n      \"source\": \"55cdf1333ff3741000c04646\",\n      \"milestone\": {\n        \"id\": 1573395,\n        \"number\": 7,\n        \"title\": \"Recipe book demo\"\n      },\n      \"labels\": [\n        {\n          \"name\": \"backlog\",\n          \"color\": \"e6e6e6\"\n        },\n        {\n          \"name\": \"Long-term\",\n          \"color\": \"5319e7\"\n        },\n        {\n          \"name\": \"estimate\",\n          \"color\": \"0052cc\"\n        }\n      ],\n      \"assignee\": {\n        \"avatar_url\": \"https://avatars.githubusercontent.com/u/13789561?v=3\",\n        \"login\": \"waffle-maker\"\n      }\n    }\n}","language":"json","status":200,"name":""}]},"settings":"","url":"/projects/:id/cards","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Content-Type: application/json\" https://api.waffle.io/projects/:id/cards?access_token=<access token>"}]},"method":"get","params":[]},"link_url":"","__v":8,"excerpt":"You can see all of the on an individual board.","hidden":false,"order":2,"sync_unique":"","updates":[],"childrenPages":[]}

get/projects/:id/cards

You can see all of the on an individual board.

This will show all of the cards on an individual project using a project's `id`. Authentication is required for private projects, not required for public projects.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will show all of the cards on an individual project using a project's `id`. Authentication is required for private projects, not required for public projects.
{"_id":"56a11f5c842b650d008888be","excerpt":"Update information on a card.","githubsync":"","hidden":false,"link_external":false,"parentDoc":null,"slug":"cardsid","title":"/cards/:id","version":"566b1ca603b4b20d00d02bd4","user":"566b1c7285fbc81700f894e5","category":"56a11ef0c29eb50d00e33e92","createdAt":"2016-01-21T18:11:40.816Z","order":3,"sync_unique":"","type":"put","updates":[],"api":{"method":"put","params":[],"results":{"codes":[{"language":"json","code":"{\n  \"_id\": \"56ba4f31ece4437100c851a2\",\n  \"project\": \"55cdf1333ff3741000c04645\",\n  \"size\": 2,\n  \"archived\": false,\n  \"githubMetadata\": {\n    \"id\": 144729103,\n    \"created_at\": \"2016-03-30T21:49:00.000Z\",\n    \"closed_at\": \"1970-01-01T00:00:00.000Z\",\n    \"updated_at\": \"2016-04-07T16:53:18.000Z\",\n    \"number\": 57,\n    \"state\": \"open\",\n    \"title\": \"new ingredient list\",\n    \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/issues/57\",\n    \"html_url\": \"https://github.com/waffle-maker/waffle-recipe/issues/57\",\n    \"comments\": 1,\n    \"source\": \"55cdf1333ff3741000c04646\",\n    \"labels\": []\n  },\n  \"associations\": []\n}","name":"","status":200}]},"settings":"","url":"/cards/:id","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X PUT -d '{\"title\": \"add 1/4 cup community\"}' -H \"Content-Type: application/json\" https://api.waffle.io/cards/:id?access_token=<access token>"}]}},"project":"566b1ca603b4b20d00d02bd1","isReference":false,"body":"This is how you can update information on a card. In this example, the title of the card was updated. You'll need to send these parameters as JSON:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"githubMetadata\\\": {\\n        \\\"body\\\": \\\"will need new ingredients \\\",\\n        \\\"labels\\\": [],\\n        \\\"milestone\\\": null,\\n        \\\"source\\\": \\\"55cdf1333ff3741000c04646\\\",  \\n        \\\"title\\\": \\\"new ingredient list\\\",\\n        \\\"number\\\": 57\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","link_url":"","__v":11,"childrenPages":[]}

put/cards/:id

Update information on a card.

This is how you can update information on a card. In this example, the title of the card was updated. You'll need to send these parameters as JSON: [block:code] { "codes": [ { "code": "{\n \"githubMetadata\": {\n \"body\": \"will need new ingredients \",\n \"labels\": [],\n \"milestone\": null,\n \"source\": \"55cdf1333ff3741000c04646\", \n \"title\": \"new ingredient list\",\n \"number\": 57\n }\n}", "language": "json" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is how you can update information on a card. In this example, the title of the card was updated. You'll need to send these parameters as JSON: [block:code] { "codes": [ { "code": "{\n \"githubMetadata\": {\n \"body\": \"will need new ingredients \",\n \"labels\": [],\n \"milestone\": null,\n \"source\": \"55cdf1333ff3741000c04646\", \n \"title\": \"new ingredient list\",\n \"number\": 57\n }\n}", "language": "json" } ] } [/block]
{"_id":"56a11f849d5a3f19001db5f0","body":"This is how you bulk archive issues. \n\n`_id` and `archived` are required, as JSON:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\\"_id\\\": \\\"56fc48067c79d3cb00f47197\\\", \\\"archived\\\": false},\\n  {\\\"_id\\\": \\\"56394205d8edab1000f41ba1\\\", \\\"archived\\\": false}\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","hidden":false,"link_external":false,"user":"566b1c7285fbc81700f894e5","__v":8,"githubsync":"","link_url":"","order":4,"type":"patch","category":"56a11ef0c29eb50d00e33e92","excerpt":"Bulk update cards for a project","parentDoc":null,"title":"/projects/:id/cards","version":"566b1ca603b4b20d00d02bd4","api":{"examples":{"codes":[{"language":"curl","code":"curl -X PATCH -d ['{\"archived\":true,\"_id\":\"56fc48067c79d3cb00f47097\"}'] -H \"Content-Type: application/json\" https://api.waffle.io/projects/:id/cards?access_token=<access token>"}]},"method":"patch","params":[],"results":{"codes":[{"language":"json","status":200,"name":"","code":"[\n  {\n    \"_id\": \"55cdf1333ff3741000c04645\",\n    \"project\": \"56e30b47c5e36c2d000e2a7b\",\n    \"archived\": true,\n    \"githubMetadata\": {\n      \"id\": 138371615,\n      \"created_at\": \"2016-03-04T04:01:19.000Z\",\n      \"closed_at\": \"2016-04-06T17:21:31.000Z\",\n      \"updated_at\": \"2016-04-06T17:21:35.000Z\",\n      \"number\": 3,\n      \"state\": \"closed\",\n      \"title\": \"waffle ingredients\",\n      \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/issues/3\",\n      \"html_url\": \"https://github.com/waffle-maker/waffle-recipe/issues/3\",\n      \"comments\": 2,\n      \"source\": \"56e30b47c5e36c2d000e2a7c\",\n      \"labels\": [\n        {\n          \"name\": \"qa\",\n          \"color\": \"a7e6e6\"\n        }\n      ]\n    }\n  }\n]"}]},"settings":"","url":"/projects/:id/cards","auth":"required"},"isReference":false,"project":"566b1ca603b4b20d00d02bd1","slug":"projectidcards","sync_unique":"","updates":[],"createdAt":"2016-01-21T18:12:20.336Z","childrenPages":[]}

patch/projects/:id/cards

Bulk update cards for a project

This is how you bulk archive issues. `_id` and `archived` are required, as JSON: [block:code] { "codes": [ { "code": "[\n {\"_id\": \"56fc48067c79d3cb00f47197\", \"archived\": false},\n {\"_id\": \"56394205d8edab1000f41ba1\", \"archived\": false}\n]", "language": "json" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is how you bulk archive issues. `_id` and `archived` are required, as JSON: [block:code] { "codes": [ { "code": "[\n {\"_id\": \"56fc48067c79d3cb00f47197\", \"archived\": false},\n {\"_id\": \"56394205d8edab1000f41ba1\", \"archived\": false}\n]", "language": "json" } ] } [/block]
{"_id":"56a11fc6932d7c0d008bf117","excerpt":"Create a new card.","parentDoc":null,"project":"566b1ca603b4b20d00d02bd1","sync_unique":"","version":"566b1ca603b4b20d00d02bd4","__v":9,"body":"This is how you create a card. \n\n`githubMetadata` is required, with a `source` and whichever properties you want to update. The `source` can be found from your [Project](doc:project).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"githubMetadata\\\": {\\n    \\t\\\"source\\\": \\\"55cdf1333ff3741000c04646\\\",  \\n    \\t\\\"title\\\": \\\"secret recipe\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","isReference":false,"link_external":false,"title":"/:owner/:repo/cards","updates":[],"category":"56a11ef0c29eb50d00e33e92","githubsync":"","hidden":false,"order":5,"createdAt":"2016-01-21T18:13:26.826Z","link_url":"","slug":"ownerrepocards-1","type":"post","user":"566b1c7285fbc81700f894e5","api":{"url":"/:owner/:repo/cards","auth":"required","examples":{"codes":[{"code":"curl -X POST -d '{\"githubMetadata\": {\"source\": \"55cdf1333ff3741000c04646\",\"title\": \"secret recipe\"}' -H \"Content-Type: application/json\" https://api.waffle.io/:owner/:repo/cards?access_token=<access token>","language":"curl"}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"project\": \"56244a11a4568d18008a6568\",\n  \"_id\": \"56fc48067c79d3cb00f47097\",\n  \"githubMetadata\": {\n    \"id\": 144727090,\n    \"created_at\": \"2016-03-30T21:41:26.000Z\",\n    \"closed_at\": \"1970-01-01T00:00:00.000Z\",\n    \"updated_at\": \"2016-03-30T21:41:26.000Z\",\n    \"number\": 22,\n    \"state\": \"open\",\n    \"title\": \"secret recipe\",\n    \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/issues/22\",\n    \"html_url\": \"https://github.com/waffle-maker/waffle-recipe/issues/22\",\n    \"comments\": 1,\n    \"source\": \"56244a11a4568d18008a6569\",\n    \"labels\": []\n  },\n  \"associations\": []\n}","name":""}]},"settings":""},"childrenPages":[]}

post/:owner/:repo/cards

Create a new card.

This is how you create a card. `githubMetadata` is required, with a `source` and whichever properties you want to update. The `source` can be found from your [Project](doc:project). [block:code] { "codes": [ { "code": "{\n \"githubMetadata\": {\n \t\"source\": \"55cdf1333ff3741000c04646\", \n \t\"title\": \"secret recipe\"\n }\n}", "language": "json" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is how you create a card. `githubMetadata` is required, with a `source` and whichever properties you want to update. The `source` can be found from your [Project](doc:project). [block:code] { "codes": [ { "code": "{\n \"githubMetadata\": {\n \t\"source\": \"55cdf1333ff3741000c04646\", \n \t\"title\": \"secret recipe\"\n }\n}", "language": "json" } ] } [/block]
{"_id":"56a150e1d847b50d00a276f1","order":0,"project":"566b1ca603b4b20d00d02bd1","title":"Columns","excerpt":"","githubsync":"","isReference":false,"link_url":"","updates":[],"api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2016-01-21T21:42:57.799Z","parentDoc":null,"type":"basic","hidden":false,"slug":"columns-1","sync_unique":"","user":"566b1c7285fbc81700f894e5","version":"566b1ca603b4b20d00d02bd4","__v":7,"body":"A `column` object represents a column on a Waffle board. You'll move cards between the columns to show what stage they're in. You can create as many columns as you'd like, but you're only able to have one `Backlog` column and one `Done` column. You can also choose to not have either of those columns. Also, every column must have a label with the exception of the `Backlog` and `Done` columns. \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Value (Example)\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"`55cdf1333ff3741000c04649`\",\n    \"0-2\": \"The unique identifier for this column.\",\n    \"1-0\": \"`displayName`\",\n    \"1-1\": \"`In Progress`\",\n    \"1-2\": \"The display name of the column.\",\n    \"2-0\": \"`isBacklog`\",\n    \"2-1\": \"`false`\",\n    \"2-2\": \"Whether this column is the `Backlog` column or not.\",\n    \"3-0\": \"`isDone`\",\n    \"3-1\": \"`false`\",\n    \"3-2\": \"Whether this column is the `Done` column or not.\",\n    \"4-0\": \"`inProgressStart`\",\n    \"4-1\": \"`true`\",\n    \"4-2\": \"Whether this column is where new issues will automatically go or not.\",\n    \"5-0\": \"`fullName`\",\n    \"5-1\": \"`waffle-maker/waffle-recipe`\",\n    \"5-2\": \"The username and repo.\",\n    \"6-0\": \"`columnDescriptionHeader`\",\n    \"6-1\": \"`In Progress Column`\",\n    \"6-2\": \"Description of which column it is.\",\n    \"7-0\": \"`columnDescriptionBody`\",\n    \"7-1\": \"`Let others know you're working on an issue by dragging it to In Progress.`\",\n    \"7-2\": \"Description of the column in the body.\",\n    \"8-0\": \"`nonCollaboratorPrStart`\",\n    \"8-1\": \"`false`\",\n    \"8-2\": \"Whether non collaborator PRs will automatically go to this column or not.\",\n    \"9-0\": \"`collaboratorPrStart`\",\n    \"9-1\": \"`false`\",\n    \"9-2\": \"Whether PRs created by collaborators on the project will automatically go to this column or not.\",\n    \"10-0\": \"`project`\",\n    \"10-1\": \"`55cdf1333ff3741000c04645`\",\n    \"10-2\": \"The unique identifier for this project.\",\n    \"11-0\": \"`rank`\",\n    \"11-1\": \"`3`\",\n    \"11-2\": \"What number position the column is in.\",\n    \"12-0\": \"`label`\",\n    \"12-1\": \"```\\n[{\\\"label\\\": {\\n      \\\"url\\\": \\\"https://api.github.com/repos/waffle-maker/waffle-recipe/labels/in%20progress\\\",\\n      \\\"name\\\": \\\"in progress\\\",\\n      \\\"color\\\": \\\"ededed\\\"\\n}]\\n```\",\n    \"12-2\": \"The list of the properties for the `label`.\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]","category":"568ed34f94c5030d00287fbc","link_external":false,"childrenPages":[]}

Columns


A `column` object represents a column on a Waffle board. You'll move cards between the columns to show what stage they're in. You can create as many columns as you'd like, but you're only able to have one `Backlog` column and one `Done` column. You can also choose to not have either of those columns. Also, every column must have a label with the exception of the `Backlog` and `Done` columns. [block:parameters] { "data": { "0-0": "`_id`", "h-0": "Name", "h-1": "Value (Example)", "h-2": "Description", "0-1": "`55cdf1333ff3741000c04649`", "0-2": "The unique identifier for this column.", "1-0": "`displayName`", "1-1": "`In Progress`", "1-2": "The display name of the column.", "2-0": "`isBacklog`", "2-1": "`false`", "2-2": "Whether this column is the `Backlog` column or not.", "3-0": "`isDone`", "3-1": "`false`", "3-2": "Whether this column is the `Done` column or not.", "4-0": "`inProgressStart`", "4-1": "`true`", "4-2": "Whether this column is where new issues will automatically go or not.", "5-0": "`fullName`", "5-1": "`waffle-maker/waffle-recipe`", "5-2": "The username and repo.", "6-0": "`columnDescriptionHeader`", "6-1": "`In Progress Column`", "6-2": "Description of which column it is.", "7-0": "`columnDescriptionBody`", "7-1": "`Let others know you're working on an issue by dragging it to In Progress.`", "7-2": "Description of the column in the body.", "8-0": "`nonCollaboratorPrStart`", "8-1": "`false`", "8-2": "Whether non collaborator PRs will automatically go to this column or not.", "9-0": "`collaboratorPrStart`", "9-1": "`false`", "9-2": "Whether PRs created by collaborators on the project will automatically go to this column or not.", "10-0": "`project`", "10-1": "`55cdf1333ff3741000c04645`", "10-2": "The unique identifier for this project.", "11-0": "`rank`", "11-1": "`3`", "11-2": "What number position the column is in.", "12-0": "`label`", "12-1": "```\n[{\"label\": {\n \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/labels/in%20progress\",\n \"name\": \"in progress\",\n \"color\": \"ededed\"\n}]\n```", "12-2": "The list of the properties for the `label`." }, "cols": 3, "rows": 13 } [/block]
A `column` object represents a column on a Waffle board. You'll move cards between the columns to show what stage they're in. You can create as many columns as you'd like, but you're only able to have one `Backlog` column and one `Done` column. You can also choose to not have either of those columns. Also, every column must have a label with the exception of the `Backlog` and `Done` columns. [block:parameters] { "data": { "0-0": "`_id`", "h-0": "Name", "h-1": "Value (Example)", "h-2": "Description", "0-1": "`55cdf1333ff3741000c04649`", "0-2": "The unique identifier for this column.", "1-0": "`displayName`", "1-1": "`In Progress`", "1-2": "The display name of the column.", "2-0": "`isBacklog`", "2-1": "`false`", "2-2": "Whether this column is the `Backlog` column or not.", "3-0": "`isDone`", "3-1": "`false`", "3-2": "Whether this column is the `Done` column or not.", "4-0": "`inProgressStart`", "4-1": "`true`", "4-2": "Whether this column is where new issues will automatically go or not.", "5-0": "`fullName`", "5-1": "`waffle-maker/waffle-recipe`", "5-2": "The username and repo.", "6-0": "`columnDescriptionHeader`", "6-1": "`In Progress Column`", "6-2": "Description of which column it is.", "7-0": "`columnDescriptionBody`", "7-1": "`Let others know you're working on an issue by dragging it to In Progress.`", "7-2": "Description of the column in the body.", "8-0": "`nonCollaboratorPrStart`", "8-1": "`false`", "8-2": "Whether non collaborator PRs will automatically go to this column or not.", "9-0": "`collaboratorPrStart`", "9-1": "`false`", "9-2": "Whether PRs created by collaborators on the project will automatically go to this column or not.", "10-0": "`project`", "10-1": "`55cdf1333ff3741000c04645`", "10-2": "The unique identifier for this project.", "11-0": "`rank`", "11-1": "`3`", "11-2": "What number position the column is in.", "12-0": "`label`", "12-1": "```\n[{\"label\": {\n \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/labels/in%20progress\",\n \"name\": \"in progress\",\n \"color\": \"ededed\"\n}]\n```", "12-2": "The list of the properties for the `label`." }, "cols": 3, "rows": 13 } [/block]
{"_id":"5696a0f5bd07400d007ac0b4","api":{"results":{"codes":[{"name":"","code":"[\n  {\n    \"_id\": \"55cdf1333ff3741000c0464a\",\n    \"displayName\": \"Done\",\n    \"isBacklog\": false,\n    \"isDone\": true,\n    \"inProgressStart\": false,\n    \"fullName\": \"waffle-maker/waffle-recipe\",\n    \"columnDescriptionHeader\": \"Done Column\",\n    \"columnDescriptionBody\": \"Issues closed in the last week are shown in this column. Drag issues here to close them.\",\n    \"nonCollaboratorPrStart\": false,\n    \"collaboratorPrStart\": false,\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"__v\": 0,\n    \"rank\": 5,\n    \"label\": null\n  },\n  {\n    \"_id\": \"55cdf1333ff3741000c04648\",\n    \"displayName\": \"Ready\",\n    \"isBacklog\": false,\n    \"isDone\": false,\n    \"inProgressStart\": false,\n    \"fullName\": \"waffle-maker/waffle-recipe\",\n    \"columnDescriptionHeader\": \"Ready Column\",\n    \"columnDescriptionBody\": \"Place issues in this column when they are ready to be worked on.\",\n    \"nonCollaboratorPrStart\": false,\n    \"collaboratorPrStart\": false,\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"__v\": 0,\n    \"rank\": 2,\n    \"label\": {\n      \"name\": \"ready\",\n      \"color\": \"00c5fe\"\n    }\n  },\n  {\n    \"_id\": \"55cdf1333ff3741000c04647\",\n    \"displayName\": \"Inbox\",\n    \"isBacklog\": true,\n    \"isDone\": false,\n    \"inProgressStart\": false,\n    \"fullName\": \"waffle-maker/waffle-recipe\",\n    \"columnDescriptionHeader\": \"Backlog Column\",\n    \"columnDescriptionBody\": \"New Issues are automatically added to this column.\",\n    \"nonCollaboratorPrStart\": false,\n    \"collaboratorPrStart\": false,\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"__v\": 0,\n    \"rank\": 0,\n    \"label\": null\n  },\n  {\n    \"_id\": \"563f76e2f187c41000fe3907\",\n    \"isBacklog\": false,\n    \"isDone\": false,\n    \"displayName\": \"Needs Review\",\n    \"collaboratorPrStart\": true,\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"fullName\": \"waffle-maker/waffle-recipe\",\n    \"__v\": 0,\n    \"columnDescriptionBody\": \"Issues and pull requests waiting on review before merging.\",\n    \"rank\": 4,\n    \"label\": {\n      \"name\": \"needs review\",\n      \"color\": \"e6e6e6\"\n    }\n  },\n  {\n    \"_id\": \"55cdf1333ff3741000c04649\",\n    \"displayName\": \"In Progress\",\n    \"isBacklog\": false,\n    \"isDone\": false,\n    \"inProgressStart\": true,\n    \"fullName\": \"waffle-maker/waffle-recipe\",\n    \"columnDescriptionHeader\": \"In Progress Column\",\n    \"columnDescriptionBody\": \"Let others know you're working on an issue by dragging it to In Progress.\",\n    \"nonCollaboratorPrStart\": false,\n    \"collaboratorPrStart\": false,\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"__v\": 0,\n    \"rank\": 3,\n    \"label\": {\n      \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/labels/in%20progress\",\n      \"name\": \"in progress\",\n      \"color\": \"ededed\"\n    }\n  },\n  {\n    \"_id\": \"56ba2aae6a97e20e00bef4a3\",\n    \"isBacklog\": false,\n    \"isDone\": false,\n    \"displayName\": \"Backlog\",\n    \"nonCollaboratorPrStart\": true,\n    \"columnDescriptionBody\": \"Issues in this column aren't ready to be worked on yet, but soon!\",\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"fullName\": \"waffle-maker/waffle-recipe\",\n    \"__v\": 0,\n    \"rank\": 1,\n    \"label\": {\n      \"name\": \"backlog\",\n      \"color\": \"e6e6e6\"\n    }\n  }\n]","language":"json","status":200}]},"settings":"","url":"/:owner/:repo/columns","auth":"required","examples":{"codes":[{"code":"curl -X GET -H \"Content-Type: application/json\" https://api.waffle.io/waffle-maker/waffle-recipe/columns?access_token=<access token>","language":"curl"}]},"method":"get","params":[]},"excerpt":"You can see all of the columns on a board.","hidden":false,"link_url":"","project":"566b1ca603b4b20d00d02bd1","type":"get","updates":[],"__v":19,"order":1,"sync_unique":"","createdAt":"2016-01-13T19:09:41.680Z","githubsync":"","isReference":false,"link_external":false,"parentDoc":null,"slug":"columns","title":"/:owner/:repo/columns","body":"This will show you all of the columns on a Waffle board.","category":"568ed34f94c5030d00287fbc","user":"566b1d1c14c22f1900f00b30","version":"566b1ca603b4b20d00d02bd4","childrenPages":[]}

get/:owner/:repo/columns

You can see all of the columns on a board.

This will show you all of the columns on a Waffle board.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will show you all of the columns on a Waffle board.
{"_id":"56a12128842b650d008888c7","createdAt":"2016-01-21T18:19:20.657Z","githubsync":"","link_external":false,"link_url":"","order":2,"parentDoc":null,"body":"This is how you update multiple columns at once. In this example, two properties were updated for the `In Progress` column; the display name and the rank. For the `Backlog` column, the display name was updated.  Every column requires a label except for the `Backlog` and `Done`, which is why the label is included for the `In Progress` column. \n\n**Warning**: The list of columns you send will become the set of columns for the project and replace all existing column. If you update 2 columns, only those 2 will be left on the board; the others will be deleted. If you only want to update one property within a column you'll use this request:  \n[/:owner/:repo/columns/:id](doc:ownerrepocolumnsid)","updates":[],"hidden":false,"sync_unique":"","type":"put","user":"566b1c7285fbc81700f894e5","api":{"results":{"codes":[{"language":"json","code":"[\n  {\n    \"_id\": \"55cdf1333ff3741000c04649\",\n    \"displayName\": \"In Progress start\",\n    \"isBacklog\": false,\n    \"isDone\": false,\n    \"inProgressStart\": true,\n    \"fullName\": \"waffle-maker/waffle-recipe\",\n    \"columnDescriptionHeader\": \"In Progress Column\",\n    \"columnDescriptionBody\": \"Let others know you're working on an issue by dragging it to In Progress.\",\n    \"nonCollaboratorPrStart\": true,\n    \"collaboratorPrStart\": false,\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"__v\": 0,\n    \"rank\": 2,\n    \"label\": {\n      \"color\": \"ededed\",\n      \"name\": \"in progress\",\n      \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/labels/in%20progress\"\n    }\n  },\n  {\n    \"_id\": \"57100087c0ae608c00291dd9\",\n    \"isBacklog\": true,\n    \"isDone\": false,\n    \"displayName\": \"Inbox\",\n    \"project\": \"55cdf1333ff3741000c04645\",\n    \"fullName\": \"waffle-maker/waffle-recipe\",\n    \"__v\": 0,\n    \"rank\": 0,\n    \"label\": null\n  }\n]","status":200}]},"settings":"","url":"/projects/:id/columns","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X PUT -d '[{\"_id\": \"55cdf1333ff3741000c04649\",\"displayName\": \"In Progress start\", \"rank\": 3, \"label\": {\"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/labels/in%20progress\",  \"name\": \"in progress\",\"color\": \"ededed\"}},{\"_id\": \"57100087c0ae608c00291dd9\",\"isBacklog\": true, \"displayName\": \"Inbox\",\"rank\": 0 }]'  -H \"Content-Type: application/json\" https://api.waffle.io/projects/:id/columns?access_token=<access token>"}]},"method":"put","params":[]},"excerpt":"Bulk update columns for a project","title":"/projects/:id/columns","__v":16,"isReference":false,"slug":"projectsidcolumns","version":"566b1ca603b4b20d00d02bd4","category":"568ed34f94c5030d00287fbc","project":"566b1ca603b4b20d00d02bd1","childrenPages":[]}

put/projects/:id/columns

Bulk update columns for a project

This is how you update multiple columns at once. In this example, two properties were updated for the `In Progress` column; the display name and the rank. For the `Backlog` column, the display name was updated. Every column requires a label except for the `Backlog` and `Done`, which is why the label is included for the `In Progress` column. **Warning**: The list of columns you send will become the set of columns for the project and replace all existing column. If you update 2 columns, only those 2 will be left on the board; the others will be deleted. If you only want to update one property within a column you'll use this request: [/:owner/:repo/columns/:id](doc:ownerrepocolumnsid)

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is how you update multiple columns at once. In this example, two properties were updated for the `In Progress` column; the display name and the rank. For the `Backlog` column, the display name was updated. Every column requires a label except for the `Backlog` and `Done`, which is why the label is included for the `In Progress` column. **Warning**: The list of columns you send will become the set of columns for the project and replace all existing column. If you update 2 columns, only those 2 will be left on the board; the others will be deleted. If you only want to update one property within a column you'll use this request: [/:owner/:repo/columns/:id](doc:ownerrepocolumnsid)
{"_id":"56a12185842b650d008888c9","githubsync":"","isReference":false,"link_external":false,"project":"566b1ca603b4b20d00d02bd1","version":"566b1ca603b4b20d00d02bd4","body":"This is how you update information on a column.","category":"568ed34f94c5030d00287fbc","link_url":"","slug":"ownerrepocolumnsid","type":"put","updates":[],"__v":8,"createdAt":"2016-01-21T18:20:53.619Z","hidden":false,"sync_unique":"","title":"/:owner/:repo/columns/:id","api":{"examples":{"codes":[{"language":"curl","code":"curl -X PUT -d '{\"displayName\": \"ready to go\"}' -H \"Content-Type: application/json\" https://api.waffle.io/waffle-maker/waffle-recipe/columns/:id?access_token=<access token>"}]},"method":"put","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_id\": \"56244a11a4568d18008a656b\",\n  \"displayName\": \"ready to go\",\n  \"isBacklog\": false,\n  \"isDone\": false,\n  \"inProgressStart\": false,\n  \"fullName\": \"waffle-maker/waffle-recipe\",\n  \"columnDescriptionHeader\": \"Ready Column\",\n  \"columnDescriptionBody\": \"Place issues in this column when they are ready to be worked on.\",\n  \"nonCollaboratorPrStart\": false,\n  \"collaboratorPrStart\": false,\n  \"project\": \"56244a11a4568d18008a6568\",\n  \"rank\": 1,\n  \"label\": {\n  \"url\": \"https://api.github.com/repos/waffle-maker/waffle-recipe/labels/ready\",\n  \"name\": \"ready\",\n  \"color\": \"bfe5bf\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/:owner/:repo/columns/:id","auth":"required"},"excerpt":"Update a column","order":4,"parentDoc":null,"user":"566b1c7285fbc81700f894e5","childrenPages":[]}

put/:owner/:repo/columns/:id

Update a column

This is how you update information on a column.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is how you update information on a column.
{"_id":"56a13cb444f3d80d00a2c2f8","body":"This is how you delete a column from a Waffle board. Any cards that were in the column previously will move to the Backlog.","excerpt":"Delete a column for a project","isReference":false,"link_url":"","slug":"ownerrepocolumnsid-1","api":{"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"}]},"settings":"","url":"/:owner/:repo/columns/:id","auth":"required","examples":{"codes":[{"code":"curl -X DEL -H \"Content-Type: application/json\" https://api.waffle.io/:owner/:repo/columns/:id?access_token=<access token>","language":"curl"}]},"method":"delete"},"category":"568ed34f94c5030d00287fbc","createdAt":"2016-01-21T20:16:52.938Z","hidden":false,"title":"/:owner/:repo/columns/:id","type":"delete","__v":2,"link_external":false,"order":5,"parentDoc":null,"project":"566b1ca603b4b20d00d02bd1","githubsync":"","sync_unique":"","updates":[],"user":"566b1c7285fbc81700f894e5","version":"566b1ca603b4b20d00d02bd4","childrenPages":[]}

delete/:owner/:repo/columns/:id

Delete a column for a project

This is how you delete a column from a Waffle board. Any cards that were in the column previously will move to the Backlog.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is how you delete a column from a Waffle board. Any cards that were in the column previously will move to the Backlog.
{"_id":"5696a3317596a90d0014e657","title":"Contact Us","type":"basic","api":{"url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"excerpt":"","githubsync":"","slug":"next-steps","sync_unique":"","body":"If you have a specific feature request or if you find a bug, please open a support ticket by emailing support@waffle.io.","isReference":false,"project":"566b1ca603b4b20d00d02bd1","user":"566b1d1c14c22f1900f00b30","updates":[],"createdAt":"2016-01-13T19:19:13.497Z","hidden":false,"link_url":"","order":0,"parentDoc":null,"__v":7,"category":"5696a138a857080d0082e8e7","link_external":false,"version":"566b1ca603b4b20d00d02bd4","childrenPages":[]}

Contact Us


If you have a specific feature request or if you find a bug, please open a support ticket by emailing support@waffle.io.
If you have a specific feature request or if you find a bug, please open a support ticket by emailing support@waffle.io.
{"_id":"57488041d929e919006ed460","link_url":"","githubsync":"","type":"basic","__v":0,"hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"excerpt":"","project":"566b1ca603b4b20d00d02bd1","version":"566b1ca603b4b20d00d02bd4","updates":[],"sync_unique":"","title":"Disclaimer","link_external":false,"order":999,"slug":"disclaimer","body":"Our API Performance is continuously being improved and new techniques are regularly implemented, so we appreciate your understanding with regard to any disruptions or changes that may occur. This is a private alpha test of our API, so please use at your own risk. We are excited to see what new uses and tools you are able to build with our data, and look forward to providing you the best API we can create!\n\nFor additional Waffle.io information, visit our [FAQ page](https://github.com/waffleio/waffle.io/wiki/FAQs).","category":"57487fe6d929e919006ed45e","user":"566b1d1c14c22f1900f00b30","createdAt":"2016-05-27T17:13:37.453Z","childrenPages":[]}

Disclaimer


Our API Performance is continuously being improved and new techniques are regularly implemented, so we appreciate your understanding with regard to any disruptions or changes that may occur. This is a private alpha test of our API, so please use at your own risk. We are excited to see what new uses and tools you are able to build with our data, and look forward to providing you the best API we can create! For additional Waffle.io information, visit our [FAQ page](https://github.com/waffleio/waffle.io/wiki/FAQs).
Our API Performance is continuously being improved and new techniques are regularly implemented, so we appreciate your understanding with regard to any disruptions or changes that may occur. This is a private alpha test of our API, so please use at your own risk. We are excited to see what new uses and tools you are able to build with our data, and look forward to providing you the best API we can create! For additional Waffle.io information, visit our [FAQ page](https://github.com/waffleio/waffle.io/wiki/FAQs).