> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt. For full content including API reference and SDK examples, see https://learning.postman.com/llms-full.txt. # Get all groups GET https://api.getpostman.com/groups Gets all of a team's Postman [groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/). Reference: https://learning.postman.com/api-docs/api-reference/groups/get-groups ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: Postman API version: 1.0.0 paths: /groups: get: operationId: getGroups summary: Get all groups description: >- Gets all of a team's Postman [groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/). tags: - groups parameters: - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getGroups' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/GetGroupsRequestUnauthorizedError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetGroupsRequestForbiddenError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetGroupsRequestInternalServerError' servers: - url: https://api.getpostman.com description: https://api.getpostman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com components: schemas: GetGroupsDataItems: type: object properties: id: type: number format: double description: The group's ID. teamId: type: number format: double description: The group's Postman team ID. name: type: string description: The group's name. summary: type: string description: The group's summary. createdBy: type: number format: double description: The ID of ther user who created the group. createdAt: type: string format: date-time description: The date and time at which the group was created. updatedAt: type: string format: date-time description: The date and time at which the group was updated. members: type: array items: type: number format: double description: The group members' IDs. roles: type: array items: type: string description: The group's roles. description: Information about the group. title: GetGroupsDataItems getGroups: type: object properties: data: type: array items: $ref: '#/components/schemas/GetGroupsDataItems' description: A list of Postman groups. title: getGroups CommonErrorTypeTitleDetailStatusType: oneOf: - type: string format: uri-reference - type: string title: CommonErrorTypeTitleDetailStatusType commonErrorTypeTitleDetailStatus: type: object properties: type: $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType' title: type: string description: A short summary of the problem. detail: type: string description: Information about the error. status: type: integer description: The error's HTTP status code. title: commonErrorTypeTitleDetailStatus CommonErrorNameMessageError: type: object properties: name: type: string description: The error name. message: type: string description: The error message. description: Information about the error. title: CommonErrorNameMessageError commonErrorNameMessage: type: object properties: error: $ref: '#/components/schemas/CommonErrorNameMessageError' description: Information about the error. title: commonErrorNameMessage GetGroupsRequestUnauthorizedError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetGroupsRequestUnauthorizedError GetGroupsRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetGroupsRequestForbiddenError CommonErrorTypeTitleDetailDetail: oneOf: - type: string - type: object additionalProperties: description: Any type description: Information about the error. title: CommonErrorTypeTitleDetailDetail commonErrorTypeTitleDetail: type: object properties: type: type: string description: The type of error. title: type: string description: A short summary of the problem. detail: $ref: '#/components/schemas/CommonErrorTypeTitleDetailDetail' description: Information about the error. title: commonErrorTypeTitleDetail GetGroupsRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetGroupsRequestInternalServerError securitySchemes: PostmanApiKey: type: apiKey in: header name: x-api-key scimApiKey: type: apiKey in: header name: Authorization description: >- A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints. basicAuth: type: http scheme: basic ``` ## Examples **Response** ```json { "data": [ { "id": 123, "teamId": 1, "name": "API Test Group", "summary": "API testing group.", "createdBy": 12345678, "createdAt": "2024-10-03T14:05:05.000Z", "updatedAt": "2024-10-03T14:05:05.000Z", "members": [ 12345678, 87654321, 56781234 ], "roles": [ "user" ] }, { "id": 456, "teamId": 1, "name": "Billing", "summary": "", "createdBy": 12345678, "createdAt": "2024-03-06T11:01:42.000Z", "updatedAt": "2024-04-04T13:36:11.000Z", "members": [ 56789012 ], "roles": [ "user" ] }, { "id": 789, "teamId": 1, "name": "Collaboration", "summary": "", "createdBy": 12345678, "createdAt": "2024-03-15T19:44:20.000Z", "updatedAt": "2024-03-15T19:44:20.000Z", "members": [ 12345678, 87654321, 56781234, 78906531, 45507812 ], "roles": [ "user" ] } ] } ``` **SDK Code** ```python Successful Response import requests url = "https://api.getpostman.com/groups" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Successful Response const url = 'https://api.getpostman.com/groups'; const options = {method: 'GET', headers: {'x-api-key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Successful Response package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.getpostman.com/groups" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Successful Response require 'uri' require 'net/http' url = URI("https://api.getpostman.com/groups") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java Successful Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.getpostman.com/groups") .header("x-api-key", "") .asString(); ``` ```php Successful Response request('GET', 'https://api.getpostman.com/groups', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp Successful Response using RestSharp; var client = new RestClient("https://api.getpostman.com/groups"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Successful Response import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.getpostman.com/groups")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```