Users

Get private user data

Changed on

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.

get/v2/users/me

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Response

Example response

{
  "data": {
    "id": "YiKoxjkaS9gjGTqhF",
    "username": "myusername",
    "profile": {
      "bio": "I started web scraping in 1985 using Altair BASIC.",
      "readme": "### Hello world 👋🏻\nI build web scrapers.",
      "name": "Jane Doe",
      "pictureUrl": "https://apify.com/img/anonymous_user_picture.png",
      "githubUsername": "torvalds.",
      "websiteUrl": "http://www.example.com",
      "twitterUsername": "@BillGates"
    },
    "email": "bob@example.com",
    "proxy": {
      "password": "ad78knd9Jkjd86",
      "groups": [
        {
          "id": "Hsu2Sk8jPqxd3dNsB",
          "name": "Group1",
          "description": "Group1 description",
          "availableCount": 10
        }
      ]
    },
    "plan": {
      "id": "Personal",
      "description": "Cost-effective plan for freelancers, developers and students.",
      "isEnabled": true,
      "monthlyBasePriceUsd": 49,
      "monthlyUsageCreditsUsd": 49,
      "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": {
        "RESIDENTIAL": 1000,
        "DATACENTER": 500,
        "GOOGLE_SERP": 200
      },
      "teamAccountSeatCount": 1,
      "supportLevel": "COMMUNITY",
      "availableAddOns": [],
      "tier": "FREE",
      "maxScheduleCount": 100,
      "maxConcurrentActorRuns": 25,
      "planVersion": 2,
      "legacyPlanId": "STARTER",
      "planTags": [],
      "overageThresholdUsd": 500,
      "maxMonthlyUnblockerUnits": 1000000,
      "maxPublicActorTaskCount": 100,
      "maxPublicActorTaskCountPerActor": 10,
      "forceBillingInterval": "ANNUAL",
      "personalizedSupport": "4h/M",
      "monitoringLevel": "STANDARD"
    },
    "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",
        "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",
        "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",
        "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",
        "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",
        "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",
        "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",
        "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",
        "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",
        "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",
        "trialExpirationAt": "2025-01-01T14:00:00.000Z"
      }
    },
    "createdAt": "2022-11-29T14:48:29.381Z",
    "isPaying": true,
    "organizationOwnerUserId": "wRsJZtadYvn4mBZmm"
  }
}

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • warning

      added the new STANDARD enum value to the // response property for the response status

    • warning

      added the new undefined enum value to the // response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became optional for the status

    • breaking

      the response property // became optional for the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status