# 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. ### Status 200 **Response Headers** ``` { "data": { "id": "YiKoxjkaS9gjGTqhF", "username": "myusername", "profile": { "bio": "I started web scraping in 1985 using Altair BASIC.", "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": [ { "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, "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": { "RESIDENTIAL": 1000, "DATACENTER": 500, "GOOGLE_SERP": 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 } } ``` **Schema** * **data** object required * **id** string required\ **Example:** `YiKoxjkaS9gjGTqhF` * **username** string required\ **Example:** `myusername` * **profile** object required * **bio** string\ **Example:** `I started web scraping in 1985 using Altair BASIC.` * **name** string\ **Example:** `Jane Doe` * **pictureUrl** string\\ **Example:** `https://apify.com/img/anonymous_user_picture.png` * **githubUsername** string\ **Example:** `torvalds.` * **websiteUrl** string\\ **Example:** `http://www.example.com` * **twitterUsername** string\ **Example:** `@BillGates` * **email** string\ required\ **Example:** `bob@example.com` * **proxy** object required * **password** string required\ **Example:** `ad78knd9Jkjd86` * **groups** object\[] required * **name** string required\ **Example:** `Group1` * **description** string required\ **Example:** `Group1 description` * **availableCount** integer required\ **Example:** `10` * **plan** object required * **id** string required\ **Example:** `Personal` * **description** string required\ **Example:** `Cost-effective plan for freelancers, developers and students.` * **isEnabled** boolean required\ **Example:** `true` * **monthlyBasePriceUsd** number required\ **Example:** `49` * **monthlyUsageCreditsUsd** number required\ **Example:** `49` * **usageDiscountPercent** number\ **Example:** `0` * **enabledPlatformFeatures** string\[] required\ **Example:** `["ACTORS","STORAGE","PROXY_SERPS","SCHEDULER","WEBHOOKS"]` * **maxMonthlyUsageUsd** number required\ **Example:** `9999` * **maxActorMemoryGbytes** number required\ **Example:** `32` * **maxMonthlyActorComputeUnits** number required\ **Example:** `1000` * **maxMonthlyResidentialProxyGbytes** number required\ **Example:** `10` * **maxMonthlyProxySerps** integer required\ **Example:** `30000` * **maxMonthlyExternalDataTransferGbytes** number required\ **Example:** `1000` * **maxActorCount** integer required\ **Example:** `100` * **maxActorTaskCount** integer required\ **Example:** `1000` * **dataRetentionDays** integer required\ **Example:** `14` * **availableProxyGroups** object required A dictionary mapping proxy group names to the number of available proxies in each group. The keys are proxy group names (e.g., "RESIDENTIAL", "DATACENTER") and values are the count of available proxies. * **property name\*** integer The number of available proxies in this group. * **teamAccountSeatCount** integer required\ **Example:** `1` * **supportLevel** string required\ **Example:** `COMMUNITY` * **availableAddOns** string\[] required\ **Example:** `[]` * **effectivePlatformFeatures** object required * **ACTORS** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **STORAGE** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **SCHEDULER** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **PROXY** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **PROXY\_EXTERNAL\_ACCESS** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **PROXY\_RESIDENTIAL** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **PROXY\_SERPS** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **WEBHOOKS** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **ACTORS\_PUBLIC\_ALL** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **ACTORS\_PUBLIC\_DEVELOPER** object required * **isEnabled** boolean required\ **Example:** `true` * **disabledReason** string | null nullable required\ **Example:** `The "Selected public Actors for developers" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com` * **disabledReasonType** string | null nullable required\ **Example:** `DISABLED` * **isTrial** boolean required\ **Example:** `false` * **trialExpirationAt** string,null\ nullable required\ **Example:** `2025-01-01T14:00:00.000Z` * **createdAt** string\ required\ **Example:** `2022-11-29T14:48:29.381Z` * **isPaying** boolean required\ **Example:** `true` ### Status 400 Bad request - invalid input parameters or request body. ``` { "error": { "type": "invalid-input", "message": "Invalid input: The request body contains invalid data." } } ``` **Schema** * **error** object required * **type** string required\ **Example:** `run-failed` * **message** string required\ **Example:** `Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)` ### Status 401 Unauthorized - authentication required or invalid token. ``` { "error": { "type": "token-not-valid", "message": "Authentication token is not valid." } } ``` **Schema** * **error** object required * **type** string required\ **Example:** `run-failed` * **message** string required\ **Example:** `Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)` ### Status 403 Forbidden - insufficient permissions to perform this action. ``` { "error": { "type": "permission-denied", "message": "You do not have permission to perform this action." } } ``` **Schema** * **error** object required * **type** string required\ **Example:** `run-failed` * **message** string required\ **Example:** `Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)` ### Status 405 Method not allowed. ``` { "error": { "type": "method-not-allowed", "message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET" } } ``` **Schema** * **error** object required * **type** string required\ **Example:** `run-failed` * **message** string required\ **Example:** `Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)` ### Status 429 Too many requests - rate limit exceeded. ``` { "error": { "type": "rate-limit-exceeded", "message": "You have exceeded the rate limit. Please try again later." } } ``` **Schema** * **error** object required * **type** string required\ **Example:** `run-failed` * **message** string required\ **Example:** `Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)`