Postman

Postman Groups API

The groups API from Postman — 2 operation(s) for groups.

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /groups List the team's user groups · Get all groups #
Ask an LLM
“What user groups exist on my Postman team?”
“Can I see all groups used to manage team permissions?”
Tell an agent
List all user groups on my team.
Show every team group and its ID.
GET /groups/{groupId} Get a user group · Get a group #
Ask an LLM
“Who belongs to a particular user group?”
“Can I look up one team group by its ID?”
Tell an agent
Get user group {groupId}.
Show the members and details of group {groupId}.

Documentation

📖
Documentation
https://www.postman.com/postman/postman-public-workspace/documentation/i2uqzpp/postman-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-groups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-group-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-groups-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postman:postman-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

postman-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Groups API
  version: 1.0.0
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
tags:
- name: Groups
paths:
  /groups:
    get:
      operationId: getGroups
      summary: Get all groups
      description: Gets all of a team's Postman 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'
  /groups/{groupId}:
    get:
      operationId: getGroup
      summary: Get a group
      description: Gets information about a Postman user group.
      tags:
      - Groups
      parameters:
      - name: groupId
        in: path
        description: The group's ID.
        required: true
        schema:
          $ref: '#/components/schemas/groupId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getGroup'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupRequestInternalServerError'
components:
  schemas:
    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
    commonErrorNameMessage:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageError'
          description: Information about the error.
      title: commonErrorNameMessage
    commonErrorNameMessageDetails:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageDetailsError'
      title: commonErrorNameMessageDetails
    getGroup:
      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.
        managers:
          type: array
          items:
            type: number
            format: double
          description: The group's managers.
      description: Information about the group.
      title: getGroup
    GetGroupRequestForbiddenError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestForbiddenError
    GetGroupRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestUnauthorizedError
    CommonErrorTypeTitleDetailStatusType:
      oneOf:
      - type: string
        format: uri-reference
      - type: string
      title: CommonErrorTypeTitleDetailStatusType
    GetGroupRequestBadRequestError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GetGroupRequestBadRequestError
    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
    CommonErrorNameMessageDetailsErrorDetails:
      oneOf:
      - type: object
        additionalProperties:
          description: Any type
      - type: array
        items:
          type: string
      description: Information about the error.
      title: CommonErrorNameMessageDetailsErrorDetails
    getGroups:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetGroupsDataItems'
          description: A list of Postman groups.
      title: getGroups
    GetGroupsRequestForbiddenError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupsRequestForbiddenError
    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
    groupId:
      type: integer
      title: groupId
    GetGroupsRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupsRequestUnauthorizedError
    GetGroupRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestInternalServerError
    CommonErrorTypeTitleDetailDetail:
      oneOf:
      - type: string
      - type: object
        additionalProperties:
          description: Any type
      description: Information about the error.
      title: CommonErrorTypeTitleDetailDetail
    CommonErrorNameMessageDetailsError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
        details:
          $ref: '#/components/schemas/CommonErrorNameMessageDetailsErrorDetails'
          description: Information about the error.
      title: CommonErrorNameMessageDetailsError
    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
    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
    basicAuth:
      type: http
      scheme: basic
    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.
x-provenance:
  first_party: true
  method: harvested
  provider_published: true
  source: https://learning.postman.com/api-docs/openapi.json
  harvested: '2026-08-05'
  note: Postman's own OpenAPI 3.1 definition for the Postman API, served by its Fern-hosted API reference. 162 paths, 256 operations, servers api.postman.com and api.eu.postman.com.