{ "info": { "_postman_id": "2be9e794-5009-444b-a6a8-5505445cf12e", "name": "Teams Public API", "description": "Teams Public API", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Teams Public API", "description": "Manage team entities", "item": [ { "name": "Get a list of teams.", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams", "query": [ { "key": "siteId", "value": "{{siteId}}", "disabled": true, "description": "[Optional] The ID of the site to retrieve teams which are site scoped." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The page size for the number of teams to return (max 300)" }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "An optional cursor token. Leave off for the first request." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation the teams are to be retrieved from.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This returns a list of all teams contained under an organization. This may be used as an option to export teams data within your organization." }, "response": [] }, { "name": "Create a team.", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams/", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation the team is to be created under.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a team, and adds the requesting user as the initial member.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get a single team.", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams/:teamId", "query": [ { "key": "siteId", "value": "{{siteId}}", "disabled": true, "description": "[Optional] The ID of the site to retrieve teams which are site scoped." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation the team is to be retrieved from.", "disabled": false }, { "key": "teamId", "value": "{{teamId}}", "description": "The ID of the team to be retrieved.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ] }, "response": [] }, { "name": "Delete a team.", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams/:teamId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation the team is to be deleted from.", "disabled": false }, { "key": "teamId", "value": "{{teamId}}", "description": "The ID of the team to be deleted.", "disabled": false } ] }, "method": "DELETE", "header": [] }, "response": [] }, { "name": "Modify a team.", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams/:teamId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation the team to be updated belongs to.", "disabled": false }, { "key": "teamId", "value": "{{teamId}}", "description": "The ID of the team to be updated.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This will only update the fields that get passed in and leave the rest as unmodified.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Restore a single soft-deleted team", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams/:teamId/restore", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation the team belongs to", "disabled": false }, { "key": "teamId", "value": "{{teamId}}", "description": "The ID of the team to restore", "disabled": false } ] }, "method": "POST", "header": [] }, "response": [] }, { "name": "Upload a team cover photo", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/:teamId/cover-photo", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "The ID of the team to be updated.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "multipart/form-data" } ], "description": "This updates the cover photo of the team. The cover photo must be a valid image file.", "body": { "mode": "formdata", "formdata": [ { "key": "file", "disabled": false, "type": "file" } ] } }, "response": [] } ] }, { "name": "Teams Members Public API", "description": "Manage the members of a team", "item": [ { "name": "Fetch a set of membership(s).", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams/:teamId/members", "query": [ { "key": "siteId", "value": "{{siteId}}", "disabled": true, "description": "[Optional] The ID of the site you are fetching members for." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation of the team you are fetching members for.", "disabled": false }, { "key": "teamId", "value": "{{teamId}}", "description": "The ID of the team you are fetching members for.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "*/*" } ], "description": "Returns a set of account IDs who are members of the team, alongside a pagination cursor to retrieve the next page (if available).", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Add a set of membership(s).", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams/:teamId/members/add", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation of the team you are adding members to.", "disabled": false }, { "key": "teamId", "value": "{{teamId}}", "description": "The ID of the team you are adding members to.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "*/*" } ], "description": "The account IDs specified will be added to the team.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Remove a set of membership(s).", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}gateway/api/public/teams/v1/org/:orgId/teams/:teamId/members/remove", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "The ID of the organisation of the team you are removing members from.", "disabled": false }, { "key": "teamId", "value": "{{teamId}}", "description": "The ID of the team you are removing members from.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "*/*" } ], "description": "The account IDs specified will be removed from the team.", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "sitename.atlassian.net" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "" } ] }