This documentation explains the specifications of Qiita API v2.
Requires secure connections with TLS to access the all endpoints of our API, without exception. Useqiita.com
host to access to the public Qiita data, otherwise use*.qiita.com
to access to Qitia:Team data.
Accepts GET, POST, PUT, PATCH, and DELETE HTTP methods. On GET request, include parameters as URI query parameters. On the other requests, include them into the request body in JSON format.
Rate limit requests from clients to protect the health of the service and maintain high service quality for other clients. The remaining number of request tokens with each request is in response header. The limitation count per hour of authenticated request is 1000, and 60 is on non-authenticated request per its IP address.
For a security reason, currently teams allowing only single sign-on authentication can be accessed via API when use only team access token.
The response status code can be 200, 201, 204, 400, 401, 403, 404, and 500. In successful cases, we use 200 for GET or PATCH requests, 201 for POST request, and 204 for PUT and DELETE requests.
Requires JSON format for communication with Qiita API v2. If you include any JSON data into your request body, put Content-Type request header with application/json. Note that the API doesn't send any response body on 204 response (successful cases to PUT or DELETE request). Date-time is rendered in ISO8601 format.
GET /api/v2/items?page=1&per_page=20 HTTP/1.1
If any error is occurred, it returns an error response including a machine-readable errortype
, and a human-readable errormessage
.
{"message":"Not found","type":"not_found"}
At some endpoints, the entire data is not returned. Instead, you can specifypage
(from 1 to 100, default: 1) andper_page
(from 1 to 100, default: 20) parameters. At this kind of endpoints, the response includesLink header in its response header. The Link header include some links to the first, next, prev, and last pages.
Link: <https://qiita.com/api/v2/users?page=1>; rel="first", <https://qiita.com/api/v2/users?page=1>; rel="prev", <https://qiita.com/api/v2/users?page=3>; rel="next", <https://qiita.com/api/v2/users?page=6>; rel="last"
The response includesTotal-Count
header too:
Total-Count: 6
The API provides a JSON Schema that describes what resources are provided via the API, what properties they have, how they are represented, and what operations they support. You can access the JSON Schema using the following URL:
Requires an access token at some endpoints such as Qiita Team or non-GET requests. You can generate access token via the OAuth 2.0 authorization flow or/settings/applications page.
Access token can be put on Authorization request header like this:
Authorization: Bearer 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcd
An access token is associated with some scopes.
Scopes are specified by the application you are authorizing to,
and you can confirm which types of scopes are required at the authorization page.
read_qiita - Allow to read data associated to the authenticated user on Qiitaread_qiita_team - Allow to read data on Qiita Teamwrite_qiita - Allow to write data on Qiitawrite_qiita_team - Allow to write data on Qiita Team
This section is for application developers. To let a user generate an access token via your application, you need to show the authorization page for your application. After a user authorized accesses via your application, the user is redirected to the URL that you registered on the application registration form. In this time, thecode
URL query parameter (andstate
parameter if needed) is included into the URL. Your application can generate an access token by sending a request toPOST /api/v2/access_tokens with thiscode
parameter.
"a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d"
"read_qiita write_qiita_team"
"bb17785d811bb1913ef54b0a7657de780defaa2d"
GET /api/v2/oauth/authorize?client_id=a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d&scope=read_qiita+write_qiita_team&state=bb17785d811bb1913ef54b0a7657de780defaa2d HTTP/1.1Host: qiita.com
HTTP/1.1 200Content-Type: text/html...
This section is for application developers. To let a user generate an team access token via your application, you need to show the authorization page for your application. After a user authorized accesses via your application, the user is redirected to the URL that you registered on the application registration form. In this time, thecode
URL query parameter (andstate
parameter if needed) is included into the URL. Your application can generate an access token by sending a request toPOST /api/v2/team_access_tokens with thiscode
parameter. Only available on Qiita Team.
"a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d"
"read_qiita_team write_qiita_team"
"bb17785d811bb1913ef54b0a7657de780defaa2d"
GET /api/v2/oauth/team_authorize?client_id=a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d&scope=read_qiita_team+write_qiita_team&state=bb17785d811bb1913ef54b0a7657de780defaa2d HTTP/1.1Host: team_name.qiita.com
HTTP/1.1 200Content-Type: text/html...
Access token for Qiita API v2
"a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d"
/^[0-9a-f]{40}$/
"ea5d0a593b2655e9568f144fb1826342292f5c6b7d406fda00577b8d1530d8a5"
/^[0-9a-f]{40}$/
Create a new access token.
required
"a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d"
/^[0-9a-f]{40}$/
required
"01fc259c31fe39e72c8ef911c3432a33d51e9337ff34c4fac86c491a0d37251f"
/^[0-9a-f]{40}$/
required
"fefef5f067171f247fb415e38cb0631797b82f4141dcdee66db846c3ade57a03"
/^[0-9a-f]{40}$/
POST /api/v2/access_tokens HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "client_id": "a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d", "client_secret": "01fc259c31fe39e72c8ef911c3432a33d51e9337ff34c4fac86c491a0d37251f", "code": "fefef5f067171f247fb415e38cb0631797b82f4141dcdee66db846c3ade57a03"}
HTTP/1.1 201Content-Type: application/json{ "client_id": "a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d", "scopes": [ "read_qiita" ], "token": "ea5d0a593b2655e9568f144fb1826342292f5c6b7d406fda00577b8d1530d8a5"}
Deactivate an access token.
DELETE /api/v2/access_tokens/:access_token HTTP/1.1Host: api.example.com
HTTP/1.1 204
It represents actions (number of views/comments/emoji reactions) to an article on Qiita Team, and is valid only on Qiita Team.
"2000-01-01T00:00:00+00:00"
"c686397e4a0f4f11683d"
/^[0-9a-f]{20}$/
100
"Example title"
"https://qiita.com/Qiita/items/c686397e4a0f4f11683d"
"2000-01-01T00:00:00+00:00"
"team_member"
Returns article reactions in descending order of the date and time the article was created.
1
/^[0-9]+$/
20
/^[0-9]+$/
"created:>=2020-01 created:<=2020-12"
GET /api/v2/items/reactions?page=1&per_page=20&query=created%3A%3E%3D2020-01+created%3A%3C%3D2020-12 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "comments": [ { "created_at": "2000-01-01T00:00:00+00:00", "id": "3391f50c35f953abfc4f", "reactions": [ { "created_at": "2000-01-01T00:00:00+00:00", "image_url": "https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png", "name": "+1", "user_id": "team_member" } ], "updated_at": "2000-01-01T00:00:00+00:00", "user_id": "team_member" } ], "created_at": "2000-01-01T00:00:00+00:00", "id": "c686397e4a0f4f11683d", "page_views_count": 100, "reactions": [ { "created_at": "2000-01-01T00:00:00+00:00", "image_url": "https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png", "name": "+1", "user_id": "team_member" } ], "title": "Example title", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "updated_at": "2000-01-01T00:00:00+00:00", "user_id": "team_member" }]
An user currently authenticated by a given access token. This resources has more detailed information than normal User resource.
"Hello, world."
"qiita"
100
200
"qiitan"
"qiita"
300
"qiita"
"Tokyo, Japan"
"Qiita キータ"
"Qiita Inc."
1
"https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439"
false
"qiita"
"https://qiita.com"
1048576
524288
Get a user associated to the current access token.
GET /api/v2/authenticated_user HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com", "image_monthly_upload_limit": 1048576, "image_monthly_upload_remaining": 524288}
A comment posted on an item or a project. A comment on a project is available only on Qiita Team.
"# Example"
"2000-01-01T00:00:00+00:00"
"3391f50c35f953abfc4f"
/^[0-9a-f]{20}$/
"<h1>Example</h1>"
"2000-01-01T00:00:00+00:00"
Delete a comment.
DELETE /api/v2/comments/:comment_id HTTP/1.1Host: api.example.com
HTTP/1.1 204
Get a comment.
GET /api/v2/comments/:comment_id HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "body": "# Example", "created_at": "2000-01-01T00:00:00+00:00", "id": "3391f50c35f953abfc4f", "rendered_body": "<h1>Example</h1>", "updated_at": "2000-01-01T00:00:00+00:00", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }}
Update a comment.
required
"# Example"
PATCH /api/v2/comments/:comment_id HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "# Example"}
HTTP/1.1 200Content-Type: application/json{ "body": "# Example", "created_at": "2000-01-01T00:00:00+00:00", "id": "3391f50c35f953abfc4f", "rendered_body": "<h1>Example</h1>", "updated_at": "2000-01-01T00:00:00+00:00", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }}
List comments on an item in newest order.
GET /api/v2/items/:item_id/comments HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "body": "# Example", "created_at": "2000-01-01T00:00:00+00:00", "id": "3391f50c35f953abfc4f", "rendered_body": "<h1>Example</h1>", "updated_at": "2000-01-01T00:00:00+00:00", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" } }]
Post a comment on an item.
required
"# Example"
POST /api/v2/items/:item_id/comments HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "# Example"}
HTTP/1.1 201Content-Type: application/json{ "body": "# Example", "created_at": "2000-01-01T00:00:00+00:00", "id": "3391f50c35f953abfc4f", "rendered_body": "<h1>Example</h1>", "updated_at": "2000-01-01T00:00:00+00:00", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }}
Create a comment by a specific user (only available on Qiita Team. administrative privileges required).
required
"# Example"
required
"qiita"
"2000-01-01T00:00:00+00:00"
"2000-01-01T00:00:00+00:00"
POST /api/v2/items/:item_id/imported_comments HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "# Example", "user_id": "qiita", "created_at": "2000-01-01T00:00:00+00:00", "updated_at": "2000-01-01T00:00:00+00:00"}
HTTP/1.1 201Content-Type: application/json{ "body": "# Example", "created_at": "2000-01-01T00:00:00+00:00", "id": "3391f50c35f953abfc4f", "rendered_body": "<h1>Example</h1>", "updated_at": "2000-01-01T00:00:00+00:00", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }}
DELETE /api/v2/comments/:comment_id/thank has been abolished since Nov 4 2020.
PUT /api/v2/comments/:comment_id/thank has been abolished since Nov 4 2020.
GET /api/v2/projects/:project_id/comments has been abolished since Oct 1 2022.
POST /api/v2/projects/:project_id/comments has been abolished since Oct 1 2022.
POST /api/v2/projects/:project_id/imported_comments has been abolished since Oct 1 2022.
An emoji reaction on Qiita Team (only availabble on Qiita Team).
"2000-01-01T00:00:00+00:00"
"https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png"
"+1"
Add an emoji reaction to a comment.
required
"+1"
POST /api/v2/comments/:comment_id/reactions HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "name": "+1"}
HTTP/1.1 201Content-Type: application/json{ "created_at": "2000-01-01T00:00:00+00:00", "image_url": "https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png", "name": "+1", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }}
Add an emoji reaction to an item.
required
"+1"
POST /api/v2/items/:item_id/reactions HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "name": "+1"}
HTTP/1.1 201Content-Type: application/json{ "created_at": "2000-01-01T00:00:00+00:00", "image_url": "https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png", "name": "+1", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }}
Delete an emoji reaction from a comment.
DELETE /api/v2/comments/:comment_id/reactions/:reaction_name HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "created_at": "2000-01-01T00:00:00+00:00", "image_url": "https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png", "name": "+1", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }}
Delete an emoji reaction from an item.
DELETE /api/v2/items/:item_id/reactions/:reaction_name HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "created_at": "2000-01-01T00:00:00+00:00", "image_url": "https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png", "name": "+1", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }}
List emoji reactions of an comment in recently-created order.
GET /api/v2/comments/:comment_id/reactions HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "created_at": "2000-01-01T00:00:00+00:00", "image_url": "https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png", "name": "+1", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" } }]
List emoji reactions of an item in recently-created order.
GET /api/v2/items/:item_id/reactions HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "created_at": "2000-01-01T00:00:00+00:00", "image_url": "https://cdn.qiita.com/emoji/twemoji/unicode/1f44d.png", "name": "+1", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" } }]
GET /api/v2/projects/:project_id/reactions has been abolished since Oct 1 2022.
POST /api/v2/projects/:project_id/reactions has been abolished since Oct 1 2022.
DELETE /api/v2/projects/:project_id/reactions/:reaction_name has been abolished since Oct 1 2022.
You can preview the expanded result of a given template. This is available only on Qiita Team.
"Weekly MTG on 2000/01/01"
[{"name"=>"MTG/2000/01/01", "versions"=>["0.0.1"]}]
"Weekly MTG on 2015/06/03"
Get a template where its variables are expanded.
required
"Weekly MTG on %{Year}/%{month}/%{day}"
required
[{"name"=>"MTG/%{Year}/%{month}/%{day}", "versions"=>["0.0.1"]}]
required
"Weekly MTG on %{Year}/%{month}/%{day}"
POST /api/v2/expanded_templates HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "Weekly MTG on %{Year}/%{month}/%{day}", "tags": [ { "name": "MTG/%{Year}/%{month}/%{day}", "versions": [ "0.0.1" ] } ], "title": "Weekly MTG on %{Year}/%{month}/%{day}"}
HTTP/1.1 201Content-Type: application/json{ "expanded_body": "Weekly MTG on 2000/01/01", "expanded_tags": [ { "name": "MTG/2000/01/01", "versions": [ "0.0.1" ] } ], "expanded_title": "Weekly MTG on 2015/06/03"}
Represents a group on Qiita Team
"2000-01-01T00:00:00+00:00"
"This group is for developers."
"Dev"
false
"2000-01-01T00:00:00+00:00"
"dev"
List groups.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/groups?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }]
Get a group.
GET /api/v2/groups/:url_name HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev"}
Create a group.
required
"dev"
required
"Dev"
"This group is for developers."
required
false
POST /api/v2/groups HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "url_name": "dev", "name": "Dev", "description": "This group is for developers.", "private": false}
HTTP/1.1 201Content-Type: application/json{ "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev"}
Update a group.
"Dev"
"This group is for developers."
false
PATCH /api/v2/groups/:url_name HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "name": "Dev", "description": "This group is for developers.", "private": false}
HTTP/1.1 200Content-Type: application/json{ "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev"}
Delete a group
DELETE /api/v2/groups/:url_name HTTP/1.1Host: api.example.com
HTTP/1.1 204
Represents a group member on Qiita Team
"qiita"
"Qiita キータ"
"example@example.com"
List members in group.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/groups/:url_name/members?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "id": "qiita", "name": "Qiita キータ", "email": "example@example.com" }]
Get a member in group.
GET /api/v2/groups/:url_name/members/:user_id HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "id": "qiita", "name": "Qiita キータ", "email": "example@example.com"}
Add a member in group.
required
["Qiita", "Qiitan"]
POST /api/v2/groups/:url_name/members HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "identities": [ "Qiita", "Qiitan" ]}
HTTP/1.1 201Content-Type: application/json{ "id": "qiita", "name": "Qiita キータ", "email": "example@example.com"}
Delete a member in group.
required
["Qiita", "Qiitan"]
DELETE /api/v2/groups/:url_name/members HTTP/1.1Host: api.example.com
HTTP/1.1 204
Represents members who are invited to on Qiita Team (only available on Qiita Team. administrative privileges required).
"example@example.com"
"https://team-name.qiita.com/registration/confirm?id=3&token=456c84ae60070161a36c08c9e710050abe5852cc"
Return list of invited members
GET api/v2/team_invitations HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "email": "example@example.com", "url": "https://team-name.qiita.com/registration/confirm?id=3&token=456c84ae60070161a36c08c9e710050abe5852cc" }]
Invite a member to the team
POST api/v2/team_invitations HTTP/1.1Host: api.example.com
HTTP/1.1 201Content-Type: application/json{ "email": "example@example.com", "url": "https://team-name.qiita.com/registration/confirm?id=3&token=456c84ae60070161a36c08c9e710050abe5852cc"}
Revoke the invitation
DELETE api/v2/team_invitations/:email HTTP/1.1Host: api.example.com
HTTP/1.1 204
Represents an item posted from a user
"<h1>Example</h1>"
"# Example"
false
100
"2000-01-01T00:00:00+00:00"
"c686397e4a0f4f11683d"
/^[0-9a-f]{20}$/
100
false
100
100
[{"name"=>"Ruby", "versions"=>["0.0.1"]}]
"Example title"
"2000-01-01T00:00:00+00:00"
"https://qiita.com/Qiita/items/c686397e4a0f4f11683d"
100
"qiita-inc"
false
List the authenticated user's items in newest order
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/authenticated_user/items?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false }]
List items.
1
/^[0-9]+$/
20
/^[0-9]+$/
"qiita user:Qiita"
GET /api/v2/items?page=1&per_page=20&query=qiita+user%3AQiita HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false }]
Create an item.
required
"# Example"
false
"dev"
false
required
[{"name"=>"Ruby", "versions"=>["0.0.1"]}]
required
"Example title"
false
"qiita-inc"
false
POST /api/v2/items HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "# Example", "coediting": false, "group_url_name": "dev", "private": false, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "tweet": false, "organization_url_name": "qiita-inc", "slide": false}
HTTP/1.1 201Content-Type: application/json{ "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false}
Delete an item.
DELETE /api/v2/items/:item_id HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false}
Get an item.
GET /api/v2/items/:item_id HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false}
Update an item.
required
"# Example"
false
"dev"
false
[{"name"=>"Ruby", "versions"=>["0.0.1"]}]
required
"Example title"
"qiita-inc"
false
PATCH /api/v2/items/:item_id HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "# Example", "coediting": false, "group_url_name": "dev", "private": false, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "organization_url_name": "qiita-inc", "slide": false}
HTTP/1.1 200Content-Type: application/json{ "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false}
Create an item by a specific user (only available on Qiita Team. administrative privileges required).
required
"# Example"
false
"dev"
required
[{"name"=>"Ruby", "versions"=>["0.0.1"]}]
required
"Example title"
required
"qiita"
"2000-01-01T00:00:00+00:00"
"2000-01-01T00:00:00+00:00"
POST /api/v2/imported_items HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "# Example", "coediting": false, "group_url_name": "dev", "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "user_id": "qiita", "created_at": "2000-01-01T00:00:00+00:00", "updated_at": "2000-01-01T00:00:00+00:00"}
HTTP/1.1 201Content-Type: application/json{ "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false}
The Like API on Qiita Team has been abolished since Nov 4 2020. Please use the Emoji reaction API instead. Unlike an item.
DELETE /api/v2/items/:item_id/like HTTP/1.1Host: api.example.com
HTTP/1.1 204
The Like API on Qiita Team has been abolished since Nov 4 2020. Please use the Emoji reaction API instead. Like an item
PUT /api/v2/items/:item_id/like HTTP/1.1Host: api.example.com
HTTP/1.1 204
Stock an item.
PUT /api/v2/items/:item_id/stock HTTP/1.1Host: api.example.com
HTTP/1.1 204
Unstock an item.
DELETE /api/v2/items/:item_id/stock HTTP/1.1Host: api.example.com
HTTP/1.1 204
Check if you stocked an item.
GET /api/v2/items/:item_id/stock HTTP/1.1Host: api.example.com
HTTP/1.1 204
The Like API on Qiita Team has been abolished since Nov 4 2020. Please use the Emoji reaction API instead. Check if you liked an item.
GET /api/v2/items/:item_id/like HTTP/1.1Host: api.example.com
HTTP/1.1 204
Stock an item.
PUT /api/v2/items/:item_id/stock HTTP/1.1Host: api.example.com
HTTP/1.1 204
List tagged items in recently-tagged order.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/tags/:tag_id/items?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false }]
List a user's items in newest order.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/users/:user_id/items?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false }]
List a user's stocked items in recently-stocked order.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/users/:user_id/stocks?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "rendered_body": "<h1>Example</h1>", "body": "# Example", "coediting": false, "comments_count": 100, "created_at": "2000-01-01T00:00:00+00:00", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "id": "c686397e4a0f4f11683d", "likes_count": 100, "private": false, "reactions_count": 100, "stocks_count": 100, "tags": [ { "name": "Ruby", "versions": [ "0.0.1" ] } ], "title": "Example title", "updated_at": "2000-01-01T00:00:00+00:00", "url": "https://qiita.com/Qiita/items/c686397e4a0f4f11683d", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }, "page_views_count": 100, "team_membership": { "name": "Qiita キータ" }, "organization_url_name": "qiita-inc", "slide": false }]
The Like API on Qiita Team has been abolished since Nov 4 2020. Please use the Emoji reaction API instead. Represents a like to an item.
"2000-01-01T00:00:00+00:00"
List likes in newest order.
GET /api/v2/items/:item_id/likes HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "created_at": "2000-01-01T00:00:00+00:00", "user": { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" } }]
Project function has been abolished since Oct 1 2022.
GET /api/v2/projects has been abolished since Oct 1 2022.
POST /api/v2/projects has been abolished since Oct 1 2022.
DELETE /api/v2/projects/:project_id has been abolished since Oct 1 2022.
GET /api/v2/projects/:project_id has been abolished since Oct 1 2022.
PATCH /api/v2/projects/:project_id has been abolished since Oct 1 2022.
POST /api/v2/imported_projects has been abolished since Oct 1 2022.
Removes the specified user from the team (you and the team owner cannot be removed with this API).
DELETE /api/v2/remove_team_member/:user_id HTTP/1.1Host: api.example.com
HTTP/1.1 204
A tag attached to an item
100
"https://s3-ap-northeast-1.amazonaws.com/qiita-tag-image/9de6a11d330f5694820082438f88ccf4a1b289b2/medium.jpg"
"qiita"
200
List tags in newest order.
1
/^[0-9]+$/
20
/^[0-9]+$/
"count"
GET /api/v2/tags?page=1&per_page=20&sort=count HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "followers_count": 100, "icon_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-tag-image/9de6a11d330f5694820082438f88ccf4a1b289b2/medium.jpg", "id": "qiita", "items_count": 200 }]
Get a tag.
GET /api/v2/tags/:tag_id HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "followers_count": 100, "icon_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-tag-image/9de6a11d330f5694820082438f88ccf4a1b289b2/medium.jpg", "id": "qiita", "items_count": 200}
List tags a user is following to in recently-tagged order.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/users/:user_id/following_tags?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "followers_count": 100, "icon_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-tag-image/9de6a11d330f5694820082438f88ccf4a1b289b2/medium.jpg", "id": "qiita", "items_count": 200 }]
Unfollow a tag.
DELETE /api/v2/tags/:tag_id/following HTTP/1.1Host: api.example.com
HTTP/1.1 204
Check if you are following a tag or not.
GET /api/v2/tags/:tag_id/following HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "followers_count": 100, "icon_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-tag-image/9de6a11d330f5694820082438f88ccf4a1b289b2/medium.jpg", "id": "qiita", "items_count": 200}
Follow a tag.
PUT /api/v2/tags/:tag_id/following HTTP/1.1Host: api.example.com
HTTP/1.1 204
Represents an association between an item and a tag.
"qiita"
["0.0.1"]
Add a tag to an item (only available on Qiita Team)
required
"qiita"
["0.0.1"]
POST /api/v2/items/:item_id/taggings HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "name": "qiita", "versions": [ "0.0.1" ]}
HTTP/1.1 201Content-Type: application/json{ "name": "qiita", "versions": [ "0.0.1" ]}
Remove a tag from an item (only available on Qiita Team)
DELETE /api/v2/items/:item_id/taggings/:tagging_id HTTP/1.1Host: api.example.com
HTTP/1.1 204
Represents a team on Qiita Team (only available on Qiita Team).
true
"qiita-inc"
"Qiita Inc."
List teams the user belongs to in newest order.
GET /api/v2/teams HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "active": true, "id": "qiita-inc", "name": "Qiita Inc." }]
Access token for Qiita API v2 (only available on Qiita Team).
"a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d"
/^[0-9a-f]{40}$/
"ea5d0a593b2655e9568f144fb1826342292f5c6b7d406fda00577b8d1530d8a5"
/^[0-9a-f]{40}$/
Create a new team access token.
required
"a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d"
/^[0-9a-f]{40}$/
required
"01fc259c31fe39e72c8ef911c3432a33d51e9337ff34c4fac86c491a0d37251f"
/^[0-9a-f]{40}$/
required
"fefef5f067171f247fb415e38cb0631797b82f4141dcdee66db846c3ade57a03"
/^[0-9a-f]{40}$/
POST /api/v2/team_access_tokens HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "client_id": "a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d", "client_secret": "01fc259c31fe39e72c8ef911c3432a33d51e9337ff34c4fac86c491a0d37251f", "code": "fefef5f067171f247fb415e38cb0631797b82f4141dcdee66db846c3ade57a03"}
HTTP/1.1 201Content-Type: application/json{ "client_id": "a91f0396a0968ff593eafdd194e3d17d32c41b1da7b25e873b42e9058058cd9d", "scopes": [ "read_qiita_team" ], "token": "ea5d0a593b2655e9568f144fb1826342292f5c6b7d406fda00577b8d1530d8a5"}
Deactivate a team access token.
DELETE /api/v2/team_access_tokens/:team_access_token HTTP/1.1Host: api.example.com
HTTP/1.1 204
Represents a member in team (only available on Qiita Team).
"Qiitaの公式アカウントです。"
"example@example.com"
"Qiita"
"2000-01-01T00:00:00+00:00"
"Qiita キータ"
List members in team.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/team_memberships?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "description": "Qiitaの公式アカウントです。", "email": "example@example.com", "id": "Qiita", "last_accessed_at": "2000-01-01T00:00:00+00:00", "name": "Qiita キータ" }]
Represents a template for generating an item boilerplate (only available on Qiita Team).
"Weekly MTG on %{Year}/%{month}/%{day}"
1
"Weekly MTG"
"Weekly MTG on 2000/01/01"
[{"name"=>"MTG/2000/01/01", "versions"=>["0.0.1"]}]
"Weekly MTG on 2015/06/03"
[{"name"=>"MTG/%{Year}/%{month}/%{day}", "versions"=>["0.0.1"]}]
"Weekly MTG on %{Year}/%{month}/%{day}"
true
List templates in a team.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/templates?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "body": "Weekly MTG on %{Year}/%{month}/%{day}", "id": 1, "name": "Weekly MTG", "expanded_body": "Weekly MTG on 2000/01/01", "expanded_tags": [ { "name": "MTG/2000/01/01", "versions": [ "0.0.1" ] } ], "expanded_title": "Weekly MTG on 2015/06/03", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "tags": [ { "name": "MTG/%{Year}/%{month}/%{day}", "versions": [ "0.0.1" ] } ], "title": "Weekly MTG on %{Year}/%{month}/%{day}", "coedit": true }]
Delete a template.
DELETE /api/v2/templates/:template_id HTTP/1.1Host: api.example.com
HTTP/1.1 204
Get a template.
GET /api/v2/templates/:template_id HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "body": "Weekly MTG on %{Year}/%{month}/%{day}", "id": 1, "name": "Weekly MTG", "expanded_body": "Weekly MTG on 2000/01/01", "expanded_tags": [ { "name": "MTG/2000/01/01", "versions": [ "0.0.1" ] } ], "expanded_title": "Weekly MTG on 2015/06/03", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "tags": [ { "name": "MTG/%{Year}/%{month}/%{day}", "versions": [ "0.0.1" ] } ], "title": "Weekly MTG on %{Year}/%{month}/%{day}", "coedit": true}
Create a new template.
required
"Weekly MTG on %{Year}/%{month}/%{day}"
required
"Weekly MTG"
required
[{"name"=>"MTG/%{Year}/%{month}/%{day}", "versions"=>["0.0.1"]}]
required
"Weekly MTG on %{Year}/%{month}/%{day}"
true
"dev"
POST /api/v2/templates HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "Weekly MTG on %{Year}/%{month}/%{day}", "name": "Weekly MTG", "tags": [ { "name": "MTG/%{Year}/%{month}/%{day}", "versions": [ "0.0.1" ] } ], "title": "Weekly MTG on %{Year}/%{month}/%{day}", "coedit": true, "group_url_name": "dev"}
HTTP/1.1 201Content-Type: application/json{ "body": "Weekly MTG on %{Year}/%{month}/%{day}", "id": 1, "name": "Weekly MTG", "expanded_body": "Weekly MTG on 2000/01/01", "expanded_tags": [ { "name": "MTG/2000/01/01", "versions": [ "0.0.1" ] } ], "expanded_title": "Weekly MTG on 2015/06/03", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "tags": [ { "name": "MTG/%{Year}/%{month}/%{day}", "versions": [ "0.0.1" ] } ], "title": "Weekly MTG on %{Year}/%{month}/%{day}", "coedit": true}
Update a template.
required
"Weekly MTG on %{Year}/%{month}/%{day}"
required
"Weekly MTG"
required
[{"name"=>"MTG/%{Year}/%{month}/%{day}", "versions"=>["0.0.1"]}]
required
"Weekly MTG on %{Year}/%{month}/%{day}"
true
"dev"
PATCH /api/v2/templates/:template_id HTTP/1.1Content-Type: application/jsonHost: api.example.com{ "body": "Weekly MTG on %{Year}/%{month}/%{day}", "name": "Weekly MTG", "tags": [ { "name": "MTG/%{Year}/%{month}/%{day}", "versions": [ "0.0.1" ] } ], "title": "Weekly MTG on %{Year}/%{month}/%{day}", "coedit": true, "group_url_name": "dev"}
HTTP/1.1 200Content-Type: application/json{ "body": "Weekly MTG on %{Year}/%{month}/%{day}", "id": 1, "name": "Weekly MTG", "expanded_body": "Weekly MTG on 2000/01/01", "expanded_tags": [ { "name": "MTG/2000/01/01", "versions": [ "0.0.1" ] } ], "expanded_title": "Weekly MTG on 2015/06/03", "group": { "created_at": "2000-01-01T00:00:00+00:00", "description": "This group is for developers.", "name": "Dev", "private": false, "updated_at": "2000-01-01T00:00:00+00:00", "url_name": "dev" }, "tags": [ { "name": "MTG/%{Year}/%{month}/%{day}", "versions": [ "0.0.1" ] } ], "title": "Weekly MTG on %{Year}/%{month}/%{day}", "coedit": true}
A Qiita user (a.k.a. account)
"Hello, world."
"qiita"
100
200
"qiitan"
"qiita"
300
"qiita"
"Tokyo, Japan"
"Qiita キータ"
"Qiita Inc."
1
"https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439"
false
"qiita"
"https://qiita.com"
List users who stocked an item in recent-stocked order.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/items/:item_id/stockers?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }]
List users in newest order.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/users?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }]
Get a user.
GET /api/v2/users/:user_id HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com"}
List users a user is following.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/users/:user_id/followees?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }]
List users who are following a user.
1
/^[0-9]+$/
20
/^[0-9]+$/
GET /api/v2/users/:user_id/followers?page=1&per_page=20 HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json[ { "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com" }]
Unfollow a user.
DELETE /api/v2/users/:user_id/following HTTP/1.1Host: api.example.com
HTTP/1.1 204
Check if the current user is following a user.
GET /api/v2/users/:user_id/following HTTP/1.1Host: api.example.com
HTTP/1.1 200Content-Type: application/json{ "description": "Hello, world.", "facebook_id": "qiita", "followees_count": 100, "followers_count": 200, "github_login_name": "qiitan", "id": "qiita", "items_count": 300, "linkedin_id": "qiita", "location": "Tokyo, Japan", "name": "Qiita キータ", "organization": "Qiita Inc.", "permanent_id": 1, "profile_image_url": "https://s3-ap-northeast-1.amazonaws.com/qiita-image-store/0/88/ccf90b557a406157dbb9d2d7e543dae384dbb561/large.png?1575443439", "team_only": false, "twitter_screen_name": "qiita", "website_url": "https://qiita.com"}
Follow a user.
PUT /api/v2/users/:user_id/following HTTP/1.1Host: api.example.com
HTTP/1.1 204