Postman

Postman users API

The users API from Postman — 3 operation(s) for users.

GitHub OpenAPI

Operations 3

GET /me Get authenticated user #
GET /users Get all team users #
GET /users/{userId} Get a team user #

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-users-api-openapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/graphql/postman-graphql.md

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-users-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-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Users 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: users
paths:
  /me:
    get:
      operationId: getAuthenticatedUser
      summary: Get authenticated user
      description: 'Gets information about the authenticated user.


        **Note:**


        - This API returns a different response for users with the [Guest and Partner roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).

        - The `flow_count` response only returns for users on [Free plans](https://www.postman.com/pricing/).

        '
      tags:
      - users
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAuthenticatedUser'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthenticatedUserRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthenticatedUserRequestInternalServerError'
  /users:
    get:
      operationId: getTeamUsers
      summary: Get all team users
      description: Gets information about all users on the [Postman team](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/collaboration-overview/).
      tags:
      - users
      parameters:
      - name: groupId
        in: query
        description: Filter results by the given [group](https://learning.postman.com/docs/collaborating-in-postman/user-groups/) ID. To get group IDs, use the GET `/groups` endpoint.
        required: false
        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/getTeamUsers'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUsersRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUsersRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUsersRequestInternalServerError'
  /users/{userId}:
    get:
      operationId: getTeamUser
      summary: Get a team user
      description: Gets information about a user on the Postman team.
      tags:
      - users
      parameters:
      - name: userId
        in: path
        description: The user's ID.
        required: true
        schema:
          $ref: '#/components/schemas/userId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamUser'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUserRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUserRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUserRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUserRequestInternalServerError'
components:
  schemas:
    getTeamUsers:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/teamUser'
          description: A list of users on the team.
      title: getTeamUsers
    GetTeamUserRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUserRequestUnauthorizedError
    GetTeamUsersRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUsersRequestUnauthorizedError
    GetAuthenticatedUserOperationsItems:
      type: object
      properties:
        limit:
          type: number
          format: double
          description: The operation's limit value.
        name:
          type: string
          description: The operation's name.
        overage:
          type: number
          format: double
          description: The operation's overage value.
        usage:
          type: number
          format: double
          description: The operation's current usage value.
      title: GetAuthenticatedUserOperationsItems
    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
    groupId:
      type: integer
      title: groupId
    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
    GetAuthenticatedUserUser:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The user's Postman ID.
        sub:
          type: string
          description: The authenticated user's ID. This ID is unique to the user and isn't associated with any Postman teams. Can return in UUID or ID format.
        username:
          type: string
          description: The user's username.
        email:
          type: string
          format: email
          description: The user's email address.
        fullName:
          type: string
          description: The user's full name.
        avatar:
          type:
          - string
          - 'null'
          format: url
          description: The user's avatar image URL.
        isPublic:
          type: boolean
          description: If true, the user's information is public and visible to all users.
        emailVerified:
          type: boolean
          description: If true, the user email address is verified by Postman.
        teamId:
          type: integer
          description: The team ID the user is assigned to. This returns a `0` value if the user is not assigned to a team.
        teamName:
          type: string
          description: The name of the team the user is assigned to.
        teamDomain:
          type: string
          description: The team's Postman domain ID.
        roles:
          type: array
          items:
            type: string
            default: user
          description: A list of the user's assigned [roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).
      description: Information about the authenticated user.
      title: GetAuthenticatedUserUser
    teamUser:
      type: object
      properties:
        id:
          type: integer
          description: The user's ID.
        name:
          type: string
          description: The user's name.
        username:
          type: string
          description: The user's username.
        email:
          type: string
          format: email
          description: The user's email address.
        roles:
          type: array
          items:
            type: string
          description: The user's roles.
        joinedAt:
          type: string
          format: date-time
          description: The user's join date.
      description: Information about the user.
      title: teamUser
    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
    CommonErrorTypeTitleDetailDetail:
      oneOf:
      - type: string
      - type: object
        additionalProperties:
          description: Any type
      description: Information about the error.
      title: CommonErrorTypeTitleDetailDetail
    CommonErrorNameMessageDetailsErrorDetails:
      oneOf:
      - type: object
        additionalProperties:
          description: Any type
      - type: array
        items:
          type: string
      description: Information about the error.
      title: CommonErrorNameMessageDetailsErrorDetails
    GetAuthenticatedUserRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAuthenticatedUserRequestInternalServerError
    GetTeamUsersRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUsersRequestInternalServerError
    GetTeamUserRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUserRequestInternalServerError
    commonErrorNameMessage:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageError'
          description: Information about the error.
      title: commonErrorNameMessage
    GetAuthenticatedUserRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAuthenticatedUserRequestUnauthorizedError
    CommonErrorTypeTitleDetailStatusType:
      oneOf:
      - type: string
        format: uri-reference
      - type: string
      title: CommonErrorTypeTitleDetailStatusType
    GetTeamUsersRequestForbiddenError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUsersRequestForbiddenError
    GetTeamUserRequestBadRequestError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GetTeamUserRequestBadRequestError
    userId:
      type: integer
      title: userId
    GetTeamUserRequestForbiddenError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUserRequestForbiddenError
    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
    getAuthenticatedUser:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/GetAuthenticatedUserUser'
          description: Information about the authenticated user.
        operations:
          type: array
          items:
            $ref: '#/components/schemas/GetAuthenticatedUserOperationsItems'
          description: Information about operations and their usage limits. This object does not return for users with the [Guest and Partner role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).
      title: getAuthenticatedUser
    commonErrorNameMessageDetails:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageDetailsError'
      title: commonErrorNameMessageDetails
  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.