Get private user data

GET 
https://api.apify.com/v2/users/me

Returns information about the current user account, including both public and private information.

The user account is identified by the provided authentication token.

The fields plan, email and profile are omitted when this endpoint is accessed from Actor run.

Responses

200

Response Headers

application/json

Schema

Schema

data objectrequired
idstringrequired
Example: YiKoxjkaS9gjGTqhF
usernamestringrequired
Example: myusername
profile objectrequired
biostring
Example: I started web scraping in 1985 using Altair BASIC.
namestring
Example: Jane Doe
pictureUrlstring
Example: /img/anonymous_user_picture.png
githubUsernamestring
Example: torvalds.
websiteUrlstring
Example: http://www.example.com
twitterUsernamestring
Example: @BillGates
emailstringrequired
Example: bob@example.com
proxy objectrequired
passwordstringrequired
Example: ad78knd9Jkjd86
groupsundefined[]required
plan objectrequired
idstringrequired
Example: Personal
descriptionstringrequired
Example: Cost-effective plan for freelancers, developers and students.
isEnabledbooleanrequired
Example: true
monthlyBasePriceUsdnumberrequired
Example: 49
monthlyUsageCreditsUsdnumberrequired
Example: 49
usageDiscountPercentnumberrequired
Example: 0
enabledPlatformFeaturesarray[]required
Example: [["ACTORS"],["STORAGE"],["PROXY_SERPS"],["SCHEDULER"],["WEBHOOKS"]]
maxMonthlyUsageUsdnumberrequired
Example: 9999
maxActorMemoryGbytesnumberrequired
Example: 32
maxMonthlyActorComputeUnitsnumberrequired
Example: 1000
maxMonthlyResidentialProxyGbytesnumberrequired
Example: 10
maxMonthlyProxySerpsnumberrequired
Example: 30000
maxMonthlyExternalDataTransferGbytesnumberrequired
Example: 1000
maxActorCountnumberrequired
Example: 100
maxActorTaskCountnumberrequired
Example: 1000
dataRetentionDaysnumberrequired
Example: 14
availableProxyGroups objectrequired
SOMEGROUPnumberrequired
Example: 20
ANOTHERGROUPnumberrequired
Example: 200
teamAccountSeatCountnumberrequired
Example: 1
supportLevelstringrequired
Example: COMMUNITY
availableAddOnsstring[]required
Example: []
effectivePlatformFeatures objectrequired
ACTORS objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
STORAGE objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
SCHEDULER objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
PROXY objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
PROXY_EXTERNAL_ACCESS objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
PROXY_RESIDENTIAL objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
PROXY_SERPS objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
WEBHOOKS objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
ACTORS_PUBLIC_ALL objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
ACTORS_PUBLIC_DEVELOPER objectrequired
isEnabledbooleanrequired
Example: true
disabledReasonstringnullablerequired
Example: The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com
disabledReasonTypestringnullablerequired
Example: DISABLED
isTrialbooleanrequired
Example: false
trialExpirationAtstringnullablerequired
Example: 2025-01-01T14:00:00.000Z
createdAtstringrequired
Example: 2022-11-29T14:48:29.381Z
isPayingbooleanrequired
Example: true

Example (auto)

{
  "data": {
    "id": "YiKoxjkaS9gjGTqhF",
    "username": "myusername",
    "profile": {
      "bio": "I started web scraping in 1985 using Altair BASIC.",
      "name": "Jane Doe",
      "pictureUrl": "/img/anonymous_user_picture.png",
      "githubUsername": "torvalds.",
      "websiteUrl": "http://www.example.com",
      "twitterUsername": "@BillGates"
    },
    "email": "bob@example.com",
    "proxy": {
      "password": "ad78knd9Jkjd86",
      "groups": [
        null
      ]
    },
    "plan": {
      "id": "Personal",
      "description": "Cost-effective plan for freelancers, developers and students.",
      "isEnabled": true,
      "monthlyBasePriceUsd": 49,
      "monthlyUsageCreditsUsd": 49,
      "usageDiscountPercent": 0,
      "enabledPlatformFeatures": [
        [
          "ACTORS"
        ],
        [
          "STORAGE"
        ],
        [
          "PROXY_SERPS"
        ],
        [
          "SCHEDULER"
        ],
        [
          "WEBHOOKS"
        ]
      ],
      "maxMonthlyUsageUsd": 9999,
      "maxActorMemoryGbytes": 32,
      "maxMonthlyActorComputeUnits": 1000,
      "maxMonthlyResidentialProxyGbytes": 10,
      "maxMonthlyProxySerps": 30000,
      "maxMonthlyExternalDataTransferGbytes": 1000,
      "maxActorCount": 100,
      "maxActorTaskCount": 1000,
      "dataRetentionDays": 14,
      "availableProxyGroups": {
        "SOMEGROUP": 20,
        "ANOTHERGROUP": 200
      },
      "teamAccountSeatCount": 1,
      "supportLevel": "COMMUNITY",
      "availableAddOns": []
    },
    "effectivePlatformFeatures": {
      "ACTORS": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "STORAGE": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "SCHEDULER": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "PROXY": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "PROXY_EXTERNAL_ACCESS": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "PROXY_RESIDENTIAL": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "PROXY_SERPS": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "WEBHOOKS": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "ACTORS_PUBLIC_ALL": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      },
      "ACTORS_PUBLIC_DEVELOPER": {
        "isEnabled": true,
        "disabledReason": "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com",
        "disabledReasonType": "DISABLED",
        "isTrial": false,
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      }
    },
    "createdAt": "2022-11-29T14:48:29.381Z",
    "isPaying": true
  }
}

Authorization: http

name: httpBearertype: httpscheme: bearerdescription: API authentication token.

• CLI
• JavaScript
• Python
• PHP
• Java
• C
• C#
• Go
• Rust
• Node.js
• Ruby
• PowerShell
• Dart
• Objective-C
• OCaml
• R
• Swift
• Kotlin

• Apify CLI

apify info

• CURL

curl -L 'https://api.apify.com/v2/users/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

https://api.apify.com

Auth

Security Scheme

httpBearerapiKey

Bearer Token

ResponseClear

Click the Send API Request button above and see the response here!