Skip to main content

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​

Response Headers
    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

    Authorization: http

    name: httpBearertype: httpscheme: bearerdescription: API authentication token.
    apify info
    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
    ResponseClear

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