Get authenticated user

GET

/me

GET

/me

curl https://api.postman.com/me \
     -H "x-api-key: <apiKey>"

{
  "user": {
    "id": 12345678,
    "sub": "4d71435e-0e67-45b9-9d4c-e3262166d157",
    "username": "taylor-lee",
    "email": "taylor.lee@example.com",
    "fullName": "Taylor Lee",
    "avatar": "https://res.cloudinary.com/postman/image/upload/t_user_profile_300/v1/user/default-6",
    "isPublic": true,
    "emailVerified": true,
    "teamId": 123,
    "teamName": "Test Team",
    "teamDomain": "test-team",
    "roles": [
      "user",
      "flow-editor",
      "community-manager"
    ]
  },
  "operations": [
    {
      "limit": 99999999,
      "name": "api_object_usage",
      "overage": 0,
      "usage": 8872
    },
    {
      "limit": 99999999,
      "name": "collection_run_limit",
      "overage": 0,
      "usage": 226
    },
    {
      "limit": 1,
      "name": "file_storage_limit",
      "overage": 0,
      "usage": 0.28
    },
    {
      "limit": 1000000,
      "name": "flow_requests",
      "overage": 0,
      "usage": 1852
    },
    {
      "limit": 99999999,
      "name": "performance_test_limit",
      "overage": 0,
      "usage": 10
    },
    {
      "limit": 100,
      "name": "reusable_packages",
      "overage": 0,
      "usage": 48
    },
    {
      "limit": 1000,
      "name": "test_data_retrieval",
      "overage": 0,
      "usage": 180
    },
    {
      "limit": 10,
      "name": "test_data_storage",
      "overage": 0,
      "usage": 0.55
    },
    {
      "limit": 2500,
      "name": "postbot_calls",
      "overage": 0,
      "usage": 0
    },
    {
      "limit": 1000000,
      "name": "mock_usage",
      "overage": 0,
      "usage": 79948
    },
    {
      "limit": 15000000,
      "name": "monitor_request_runs",
      "overage": 0,
      "usage": 4493710
    },
    {
      "limit": 1000000,
      "name": "api_usage",
      "overage": 0,
      "usage": 10788
    }
  ]
}

Gets information about the authenticated user.

Note:

This API returns a different response for users with the Guest and Partner roles.
The flow_count response only returns for users on Free plans.

Authentication

x-api-keystring

API Key authentication via header

Response

Successful Response

userobjectOptional

Information about the authenticated user.

operationslist of objectsOptional

Information about operations and their usage limits. This object does not return for users with the Guest and Partner role.

Errors

401

Unauthorized Error

500

Internal Server Error