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.
Top Level Types
The following types are returned as the top level type (found in items on the common response object) by methods.
Note that some top level types can also be returned as members of other types, for example answers on question objects.
Answers
Each of these methods returns answer objects.
Get all answers on the site.
Get answers identified by a set of ids.
Casts an accept vote on the given answer.
Undoes an accept vote on the given answer.
Deletes the given answer.
Casts a downvote on the given answer.
Undoes a downvote on the given answer.
Casts an upvote on the given answer.
Undoes an upvote on the given answer.
Casts a flag on the given answer.
Get the answers to the questions identified by a set of ids.
Creates an answer on the given question.
Renders a hypothetical answer to a question.
Get the answers posted by the users identified by a set of ids.
Get the top answers a user has posted on questions with a set of tags.
Articles
Add/Edit/Delete Only available for Business Teams.
Get all articles on the site.
Get the articles identified by a set of ids.
Deletes the given article.
Badges
Each of these methods returns badge objects.
Get all badges on the site, in alphabetical order.
Get the badges identified by ids.
Get the recent recipients of the given badges.
Get all non-tagged-based badges in alphabetical order.
Get badges recently awarded on the site.
Get all tagged-based badges in alphabetical order.
Get the badges earned by the users identified by a set of ids.
Comments
Each of these methods returns comment objects.
Get comments on the answers identified by a set of ids.
Get comments on the articles identified by a set of ids.
Get all comments on the site.
Get comments identified by a set of ids.
Delete a comment identified by its id.
Edit a comment identified by its id.
Casts a flag on the given comment.
Casts an upvote on the given comment.
Undoes an upvote on the given comment.
Get comments on the posts (question or answer) identified by a set of ids.
Create a new comment on the post identified by id.
Renders a hypothetical comment on the given post.
Get the comments on the questions identified by a set of ids.
Get the comments posted by the users identified by a set of ids.
Get the comments posted by a set of users in reply to another user.
Get the comments that mention one of the users identified by a set of ids.
Errors
Each of these methods returns error objects.
Get descriptions of all the errors that the API could return.
Filters
Each of these methods returns filter objects.
For an explanation of creating and using filters, refer to the filter documentation.
Decode a set of filters, useful for debugging purposes.
Flag Options
Each of these methods returns flag_option objects.
Returns valid flag options for the given answer.
Returns valid flag options for the given comment.
Returns valid flag options which are also close reasons for the given question.
Returns valid flag options for the given question.
Info
Each of these methods returns info objects.
Get information about the entire site.
Posts
Each of these methods returns post objects.
Get all posts (questions and answers) in the system.
Get all posts identified by a set of ids. Useful for when the type of post (question or answer) is not known.
Get all posts (questions and answers) owned by a set of users.
Privileges
Each of these methods returns privilege objects.
Get all the privileges available on the site.
Get the privileges the given user has on the site.
Questions
Each of these methods returns question objects.
Gets all questions the answers identified by ids are on.
Get the questions that are linked to the articles identified by a set of ids.
Get all questions on the site.
Get the questions identified by a set of ids.
Deletes the given question.
Casts a downvote on the given question.
Undoes a downvote on the given question.
Edits the given question.
Bookmarks the given question. (Previously known as "favoriting" a question)
Undoes bookmarking the given question. (Previously known as "favoriting" a question)
Casts a flag on the given question.
Get the questions that link to the questions identified by a set of ids.
Get the questions that are related to the questions identified by a set of ids.
Casts an upvote on the given question.
Undoes an upvote on the given question.
Get all questions on the site with active bounties.
Renders a hypothetical question.
Get all questions the site considers unanswered.
Get questions the site considers unanswered within a user's favorite or interesting tags.
Get all questions on the site with no answers.
Search the site for questions meeting certain criteria.
Search the site for questions using most of the on-site search options.
Search the site based on similarity to a title.
Get frequently asked questions in a set of tags.
Get the questions bookmarked (previously known as "favorited") by users identified by a set of ids.
Get the questions asked by the users identified by a set of ids.
Get the questions on which a set of users, have active bounties.
Get the questions asked by a set of users, which have no answers.
Get the questions asked by a set of users, which have at least one answer but no accepted answer.
Get the questions asked by a set of users, which are not considered to be adequately answered.
Get the top questions a user has posted with a set of tags.
Question Timelines
Reputation
Each of these methods returns reputation objects.
Get a subset of the reputation changes experienced by the users identified by a set of ids.
Reputation History
Each of these methods returns reputation_history objects.
Get a history of a user's reputation, excluding private events.
Get a full history of a user's reputation.
Revisions
Each of these methods returns revision objects.
Get revisions on the set of posts in ids.
Get all revisions identified by a set of ids.
Search Excerpts
Suggested Edits
Each of these methods returns suggested_edit objects.
Get suggested edits on the set of posts in ids.
Get all the suggested edits on the site.
Get the suggested edits identified by a set of ids.
Get the suggested edits provided by users identified by a set of ids.
Creates a suggested edit on an existing answer.
Creates a suggested edit on an existing question.
Tags
Each of these methods returns tag objects.
Get the tags on the site.
Get the tags on the site that only moderators can use.
Get the tags on the site that fulfill required tag constraints.
Get tags on the site by their names.
Get related tags, based on common tag pairings.
Get the tags that the users (identified by a set of ids) have been active in.
Tag Scores
Each of these methods returns tag_score objects.
Get the top answer posters in a specific tag, either in the last month or for all time.
Get the top question askers in a specific tag, either in the last month or for all time.
Tag Synonyms
Each of these methods returns tag_synonym objects.
Get all the tag synonyms on the site.
Get the synonyms for a specific set of tags.
Tag Wikis
Each of these methods returns tag_wiki objects.
Get the wiki entries for a set of tags.
Top Tags
Each of these methods returns top_tag objects.
Get the top tags (by score) a single user has posted answers in.
Get the top tags (by score) a single user has asked questions in.
Get the top tags (by score) a single user has posted in.
Users
Each of these methods returns user objects.
Get all users on the site.
Get the users identified by a set of ids.
Get the users who have moderation powers on the site.
User Timeline
Each of these methods returns user_timeline objects.
Get a subset of the actions of that have been taken by the users identified by a set of ids.
Member Types
The following types are not returned directly by any method, but are found as members on other types.