Postman groups API

openapi: 3.1.0
info:
  title: Postman Groups API
  version: 1.0.0
  description: 'Operations tagged groups across 2 of this provider''s published API definitions: postman-api-openapi.yml, postman-groups-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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](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.postman.com
      description: https://api.postman.com
    - url: https://api.eu.postman.com
      description: https://api.eu.postman.com
  /groups/{groupId}:
    get:
      operationId: getGroup
      summary: Get a group
      description: Gets information about a Postman [user group](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).
      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'
    servers:
    - url: https://api.postman.com
      description: https://api.postman.com
    - url: https://api.eu.postman.com
      description: https://api.eu.postman.com
components:
  schemas:
    GetGroupRequestBadRequestError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GetGroupRequestBadRequestError
    GetGroupRequestForbiddenError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestForbiddenError
    commonErrorNameMessageDetails:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageDetailsError'
      title: commonErrorNameMessageDetails
    CommonErrorTypeTitleDetailStatusType:
      oneOf:
      - type: string
        format: uri-reference
      - type: string
      title: CommonErrorTypeTitleDetailStatusType
    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
    GetGroupsRequestForbiddenError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupsRequestForbiddenError
    GetGroupRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestUnauthorizedError
    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
    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
    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
    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
    GetGroupRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestInternalServerError
    GetGroupsRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupsRequestUnauthorizedError
    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
    commonErrorNameMessage:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageError'
          description: Information about the error.
      title: commonErrorNameMessage
    GetGroupsRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupsRequestInternalServerError
    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
  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-refined-from:
- postman-api-openapi.yml
- postman-groups-api-openapi.yml
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.