Add GET /api/v1/sites/teams endpoint and make related adjustments#5220
Merged
Add GET /api/v1/sites/teams endpoint and make related adjustments#5220
GET /api/v1/sites/teams endpoint and make related adjustments#5220Conversation
aerosol
reviewed
Mar 20, 2025
aerosol
reviewed
Mar 20, 2025
aerosol
approved these changes
Mar 20, 2025
44af061 to
be8642c
Compare
e1bd567 to
de3fd76
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
This PR adds a Sites API endpoint for listing teams the user is a member in. The team identifier from that endpoint can be used when either creating sites via
POST /api/v1/sitesto create a site under a particular team or scope the list of sites to a particular team withGET /api/v1/sites?team_id=....The team identifier input was removed from Team Settings to avoid confusing users who don't actively use the API, which is the only place where identifier is explicitly used so far.
The endpoint is under scope which is implicitly available to all API keys. The
api_availablefield on team entry determines if the team has Stats API feature enabled. If it's disabled, it's not possible to create sites under it (or, for that matter, run other API queries against its sites).The
GET /api/v1/sitesendpoint was adjusted to scope sites to a team exclusively, if an identifier is provided.TODO
make updates to API docs after Document Sites APIextended docs in Document Sites APIguestsresource docs#591 is inguestsresource docs#591Tests