Stack Overflow for Teams API

Stack Overflow for Teams API v2.3

This is the documentation for the Stack Overflow for Teams API v2.3.

This API is available for the following subscription tiers:

Basic - read only
Business - read/write

Requests

All requests to the API require:

A query string param team containing the slug of the team that will be target of the API call. For example, if your team lives in stackoverflowteams.com/c/my-team, the slug is my-team.
A header X-API-Access-Token with an access token. See authentication on how to get one.

Example request:

curl -X GET -H 'X-API-Access-Token: my-personal-access-token' 'https://api.stackoverflowteams.com/2.3/questions?team=my-team'

General

All API responses are JSON, we do support JSONP with the callback query parameter. Every response in the API is returned in a common "wrapper" object, for easier and more consistent parsing.

Additionally, all API responses are compressed. The Content-Encoding header is always set, but some proxies will strip this out. The proper way to decode API responses can be found here.

Developers can trim API responses down to just the fields they are interested in using custom filters. Many types have fields that are not normally returned (question bodies, for example) that can likewise be requested via a custom filter.

A number of methods in the Stack Overflow for Teams API accept dates as parameters and return dates as properties, the format of these dates is consistent and documented. All dates are in unix epoch time.

Unless otherwise noted, the maximum size of any page is 100, any {ids} parameter likewise is capped at 100 elements, all indexes start at 1.

If a parameter name is plural it accepts vectorized requests, otherwise a single value may be passed.

It is possible to compose reasonably complex queries against the sites using the min, max, fromdate, todate, and sort parameters. Most, but not all, methods accept some or all of these parameters, the documentation for individual methods will highlight which do. Most methods also have a common set of paging parameters.

by category by type

Per-Site Methods

Answers

answers

Get all answers on the site.

answers/{ids}

Get answers identified by a set of ids.

answers/{id}/accept

Casts an accept vote on the given answer.

answers/{id}/accept/undo

Undoes an accept vote on the given answer.

answers/{ids}/comments

Get comments on the answers identified by a set of ids.

answers/{id}/delete

Deletes the given answer.

answers/{id}/downvote

Casts a downvote on the given answer.

answers/{id}/downvote/undo

Undoes a downvote on the given answer.

answers/{id}/edit

Edits the given answer.

answers/{id}/flags/options

Returns valid flag options for the given answer.

answers/{id}/flags/add

Casts a flag on the given answer.

answers/{ids}/questions

Gets all questions the answers identified by ids are on.

answers/{id}/upvote

Casts an upvote on the given answer.

answers/{id}/upvote/undo

Undoes an upvote on the given answer.

answers/{id}/suggested-edit/add

Creates a suggested edit on an existing answer.

Articles

Add/Edit/Delete Only available for Business Teams.

articles

Get all articles on the site.

articles/{ids}

Get the articles identified by a set of ids.

articles/{ids}/comments

Get comments on the articles identified by a set of ids.

articles/{ids}/linked

Get the questions that are linked to the articles identified by a set of ids.

articles/{id}/delete

Deletes the given article.

articles/{id}/edit

Edits the given article.

articles/add

Creates a new article.

Badges

badges

Get all badges on the site, in alphabetical order.

badges/{ids}

Get the badges identified by ids.

badges/name

Get all non-tagged-based badges in alphabetical order.

badges/recipients

Get badges recently awarded on the site.

badges/{ids}/recipients

Get the recent recipients of the given badges.

badges/tags

Get all tagged-based badges in alphabetical order.

Comments

comments

Get all comments on the site.

comments/{ids}

Get comments identified by a set of ids.

comments/{id}/delete

Delete a comment identified by its id.

comments/{id}/edit

Edit a comment identified by its id.

comments/{id}/flags/add

Casts a flag on the given comment.

comments/{id}/flags/options

Returns valid flag options for the given comment.

comments/{id}/upvote

Casts an upvote on the given comment.

comments/{id}/upvote/undo

Undoes an upvote on the given comment.

Info

info

Get information about the entire site.

Posts

posts

Get all posts (questions and answers) in the system.

posts/{ids}

Get all posts identified by a set of ids. Useful for when the type of post (question or answer) is not known.

posts/{ids}/comments

Get comments on the posts (question or answer) identified by a set of ids.

posts/{id}/comments/add

Create a new comment on the post identified by id.

posts/{id}/comments/render

Renders a hypothetical comment on the given post.

posts/{ids}/revisions

Get revisions on the set of posts in ids.

posts/{ids}/suggested-edits

Get suggested edits on the set of posts in ids.

Privileges

privileges

Get all the privileges available on the site.

Questions

questions

Get all questions on the site.

questions/{ids}

Get the questions identified by a set of ids.

questions/{ids}/answers

Get the answers to the questions identified by a set of ids.

questions/{id}/answers/add

Creates an answer on the given question.

questions/{id}/answers/render

Renders a hypothetical answer to a question.

questions/{id}/close/options

Returns valid flag options which are also close reasons for the given question.

questions/{ids}/comments

Get the comments on the questions identified by a set of ids.

questions/{id}/delete

Deletes the given question.

questions/{id}/downvote

Casts a downvote on the given question.

questions/{id}/downvote/undo

Undoes a downvote on the given question.

questions/{id}/edit

Edits the given question.

questions/{id}/favorite

Bookmarks the given question. (Previously known as "favoriting" a question)

questions/{id}/favorite/undo

Undoes bookmarking the given question. (Previously known as "favoriting" a question)

questions/{id}/flags/add

Casts a flag on the given question.

questions/{id}/flags/options

Returns valid flag options for the given question.

questions/{ids}/linked

Get the questions that link to the questions identified by a set of ids.

questions/{ids}/related

Get the questions that are related to the questions identified by a set of ids.

questions/{id}/suggested-edit/add

Creates a suggested_edit on an existing question.

questions/{ids}/timeline

Get the timelines of the questions identified by a set of ids.

questions/{id}/upvote

Casts an upvote on the given question.

questions/{id}/upvote/undo

Undoes an upvote on the given question.

questions/add

Creates a new question.

questions/featured

Get all questions on the site with active bounties.

questions/no-answers

Get all questions on the site with no answers.

questions/render

Renders a hypothetical question.

questions/unanswered

Get all questions the site considers unanswered.

questions/unanswered/my-tags

Get questions the site considers unanswered within a user's favorite or interesting tags.

Revisions

revisions/{ids}

Get all revisions identified by a set of ids.

Search

Search the site for questions meeting certain criteria.

search/advanced

Search the site for questions using most of the on-site search options.

similar

Search the site based on similarity to a title.

search/excerpts

Searches a site.

Suggested Edits

suggested-edits

Get all the suggested edits on the site.

suggested-edits/{ids}

Get the suggested edits identified by a set of ids.

/me/mentioned

Get the comments that mention one of the users identified by a set of ids.

users/{ids}/posts

/me/posts

Get all posts (questions and answers) owned by a set of users.

users/{id}/privileges

/me/privileges

Get the privileges the given user has on the site.

users/{ids}/questions

/me/questions

Get the questions asked by the users identified by a set of ids.

users/{ids}/questions/featured

/me/questions/featured

Get the questions on which a set of users, have active bounties.

users/{ids}/questions/no-answers

/me/questions/no-answers

Get the questions asked by a set of users, which have no answers.

users/{ids}/questions/unaccepted

/me/questions/unaccepted

Get the questions asked by a set of users, which have at least one answer but no accepted answer.

users/{ids}/questions/unanswered

/me/questions/unanswered

Get the questions asked by a set of users, which are not considered to be adequately answered.

users/{ids}/reputation

/me/reputation

Get a subset of the reputation changes experienced by the users identified by a set of ids.

users/{ids}/reputation-history

/me/reputation-history

Get a history of a user's reputation, excluding private events.

users/{id}/reputation-history/full

/me/reputation-history/full

Get a full history of a user's reputation.

users/{ids}/suggested-edits

/me/suggested-edits

Get the suggested edits provided by users identified by a set of ids.

users/{ids}/tags

/me/tags

Get the tags that the users (identified by a set of ids) have been active in.

users/{id}/tags/{tags}/top-answers

/me/tags/{tags}/top-answers

Get the top answers a user has posted on questions with a set of tags.

users/{id}/tags/{tags}/top-questions

/me/tags/{tags}/top-questions

Get the top questions a user has posted with a set of tags.

users/{id}/tag-preferences

/me/tag-preferences

Get a given user's tag preferences.

users/{id}/tag-preferences/edit

/me/tag-preferences/edit

Edit a user's tag preferences.

users/{ids}/timeline

/me/timeline

Get a subset of the actions of that have been taken by the users identified by a set of ids.

users/{id}/top-answer-tags

/me/top-answer-tags

Get the top tags (by score) a single user has posted answers in.

users/{id}/top-question-tags

/me/top-question-tags

Get the top tags (by score) a single user has asked questions in.

users/{id}/top-tags

/me/top-tags

Get the top tags (by score) a single user has posted in.

users/moderators

Get the users who have moderation powers on the site.