--- title: "Get Actor" method: GET path: "/v2/actors/{actorId}" tags: ["Actors"] --- # Get Actor `GET /v2/actors/{actorId}` Gets an object that contains all the details about a specific Actor. ## Path parameters - `actorId` string, required ## Response `200` - ActorResponse — Response containing Actor data. - `data` Actor, required - `id` string, required - `userId` string, required - `name` string, required - `username` string, required - `description` string, nullable - `restartOnError` boolean - `isPublic` boolean, required - `actorPermissionLevel` 'LIMITED_PERMISSIONS' | 'FULL_PERMISSIONS' — Determines the permission level that the Actor requires to run. For details, see [Actor permissions](https://docs.apify.com/platform/actors/development/permissions). - `createdAt` string, date-time, required - `modifiedAt` string, date-time, required - `stats` ActorStats, required - `totalBuilds` integer - `totalRuns` integer - `totalUsers` integer - `totalUsers7Days` integer - `totalUsers30Days` integer - `totalUsers90Days` integer - `totalMetamorphs` integer - `lastRunStartedAt` string, date-time - `actorReviewCount` integer - `actorReviewRating` number - `bookmarkCount` integer - `publicActorRunStats30Days` object — Run status counts over the past 30 days. - `ABORTED` integer - `FAILED` integer - `SUCCEEDED` integer - `TIMED-OUT` integer - `TOTAL` integer - `versions` Version[], required - `versionNumber` string, required — The version number of the Actor. Two numbers separated by a dot, that represent the `MAJOR.MINOR` part of the semantic versioning. - `sourceType` 'SOURCE_FILES' | 'GIT_REPO' | 'TARBALL' | 'GITHUB_GIST' | 'SOURCE_CODE', required - `envVars` EnvVar[], nullable — Environment variables for the version. - `name` string, required — The name of the environment variable. - `value` string — The value of the environment variable. If `isSecret` is `true`, this value isn't returned by the API. - `isSecret` boolean, nullable — Whether the environment variable is encrypted. Secret values aren't returned by the API. - `applyEnvVarsToBuild` boolean, nullable — Whether to inject the environment variables at build time. - `buildTag` string, nullable — The tag name to apply to a successful build of this version. Can be `null` when the version has no build tag. - `sourceFiles` union[] - union - SourceCodeFile — Represents a single file in the Actor's source code. - `format` 'BASE64' | 'TEXT' - `content` string — The contents of the file. Interpreted based on the value of `format`. - `name` string, required — The path of the file relative to the Actor's root directory. - SourceCodeFolder — Represents a folder in the Actor's source code structure. Distinguished from SourceCodeFile by the presence of the `folder` property set to `true`. - `name` string, required — The path of the folder relative to the Actor's root directory. - `folder` boolean, required — Whether it's a folder. Distinguishes folders from files. - `gitRepoUrl` string, nullable — URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`. - `tarballUrl` string, nullable — URL to download the source code from as a tarball or ZIP file. Applies when the `sourceType` is `TARBALL`. - `gitHubGistUrl` string, nullable — URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`. - `pricingInfos` ActorRunPricingInfo[] - union - PayPerEventActorPricingInfo - `apifyMarginPercentage` number, required — In [0, 1], fraction of pricePerUnitUsd that goes to Apify - `createdAt` string, date-time, required — When this pricing info record has been created - `startedAt` string, date-time, required — Since when is this pricing info record effective for a given Actor - `notifiedAboutFutureChangeAt` string, date-time, nullable - `notifiedAboutChangeAt` string, date-time, nullable - `reasonForChange` string, nullable - `isPriceChangeNotificationSuppressed` boolean - `forceContainsSignificantPriceChange` boolean - `pricingModel` 'PAY_PER_EVENT', required - `pricingPerEvent` object, required - `actorChargeEvents` object - `minimalMaxTotalChargeUsd` number, nullable - PricePerDatasetItemActorPricingInfo - `apifyMarginPercentage` number, required — In [0, 1], fraction of pricePerUnitUsd that goes to Apify - `createdAt` string, date-time, required — When this pricing info record has been created - `startedAt` string, date-time, required — Since when is this pricing info record effective for a given Actor - `notifiedAboutFutureChangeAt` string, date-time, nullable - `notifiedAboutChangeAt` string, date-time, nullable - `reasonForChange` string, nullable - `isPriceChangeNotificationSuppressed` boolean - `forceContainsSignificantPriceChange` boolean - `pricingModel` 'PRICE_PER_DATASET_ITEM', required - `unitName` string, required — Name of the unit that is being charged - `pricePerUnitUsd` number — Price per unit in USD. Mutually exclusive with `tieredPricing` - exactly one of the two is present on a pricing record. - `tieredPricing` TieredPricingPerDatasetItem — Tiered price-per-dataset-item pricing, keyed by subscription tier (e.g. `FREE`, `BRONZE`, `SILVER`, `GOLD`, `PLATINUM`, `DIAMOND`). The actual price applied to a run is resolved from the user's tier. - FlatPricePerMonthActorPricingInfo - `apifyMarginPercentage` number, required — In [0, 1], fraction of pricePerUnitUsd that goes to Apify - `createdAt` string, date-time, required — When this pricing info record has been created - `startedAt` string, date-time, required — Since when is this pricing info record effective for a given Actor - `notifiedAboutFutureChangeAt` string, date-time, nullable - `notifiedAboutChangeAt` string, date-time, nullable - `reasonForChange` string, nullable - `isPriceChangeNotificationSuppressed` boolean - `forceContainsSignificantPriceChange` boolean - `pricingModel` 'FLAT_PRICE_PER_MONTH', required - `trialMinutes` integer, required — For how long this Actor can be used for free in trial period - `pricePerUnitUsd` number, required — Monthly flat price in USD - FreeActorPricingInfo - `apifyMarginPercentage` number, required — In [0, 1], fraction of pricePerUnitUsd that goes to Apify - `createdAt` string, date-time, required — When this pricing info record has been created - `startedAt` string, date-time, required — Since when is this pricing info record effective for a given Actor - `notifiedAboutFutureChangeAt` string, date-time, nullable - `notifiedAboutChangeAt` string, date-time, nullable - `reasonForChange` string, nullable - `isPriceChangeNotificationSuppressed` boolean - `forceContainsSignificantPriceChange` boolean - `pricingModel` 'FREE', required - `defaultRunOptions` DefaultRunOptions, required — The default settings applied to an Actor run. Can be overridden elsewhere. - `build` string — Which build to run. Either a build tag or a version number. - `timeoutSecs` integer — Timeout in seconds. 0 if no timeout. - `memoryMbytes` integer — In MB, the amount of memory allocated to the run. - `restartOnError` boolean — Whether to automatically restart the run if it fails. - `maxItems` integer, nullable — Maximum number of items the run might produce. - `forcePermissionLevel` 'LIMITED_PERMISSIONS' | 'FULL_PERMISSIONS' — Determines the permission level that the Actor requires to run. For details, see [Actor permissions](https://docs.apify.com/platform/actors/development/permissions). - `exampleRunInput` ExampleRunInput - `body` string — Sample input, serialized as a string. - `contentType` string — MIME type of `body`. - `isDeprecated` boolean, nullable - `deploymentKey` string - `title` string, nullable - `taggedBuilds` TaggedBuilds — A dictionary mapping build tag names (e.g., "latest", "beta") to their build information. - `actorStandby` ActorStandby - `isEnabled` boolean, nullable — Whether standby mode is enabled for the Actor. - `desiredRequestsPerActorRun` integer, nullable — Target number of concurrent HTTP requests a single run is configured to handle. - `maxRequestsPerActorRun` integer, nullable — Maximum number of concurrent HTTP requests that can be routed to a single run. - `idleTimeoutSecs` integer, nullable — In seconds, how long a run can stay idle without incoming requests before it's terminated. - `build` string, nullable — Which build to run in standby mode. Either a build tag or a version number. - `memoryMbytes` integer, nullable — In MB, the amount of memory allocated to the run. - `disableStandbyFieldsOverride` boolean, nullable — If `true`, prevents the standby mode configuration from being overridden elsewhere. - `shouldPassActorInput` boolean, nullable — Whether to pass the Actor's input to the standby run. If `false`, the standby runs start with no input. - `readmeSummary` string — A brief, LLM-generated readme summary - `seoTitle` string, nullable - `seoDescription` string, nullable - `pictureUrl` string, nullable - `standbyUrl` string, nullable - `notice` string, nullable - `categories` string[] - `isCritical` boolean - `isGeneric` boolean - `isSourceCodeHidden` boolean - `hasNoDataset` boolean ## Other responses - `400` — Bad request - invalid input parameters or request body. - `401` — Unauthorized - authentication required or invalid token. - `403` — Forbidden - insufficient permissions to perform this action. - `404` — Not found - the requested resource does not exist. - `405` — Method not allowed. - `429` — Too many requests - rate limit exceeded. ## Changes - **2026-07-31** `5ceb2cdfe616` — 1 info - api operation id `act_get` removed and replaced with `actor_get` - **2026-07-26** `b94a8abdfff1` — 1 breaking, 6 warning - the response property `data/taggedBuilds/anyOf[subschema #1: TaggedBuilds]/additionalProperties/anyOf[subschema #1: TaggedBuildInfo]/buildNumber` became nullable for the status `200` - added the new `cannot-monetize-without-payout-billing-info` enum value to the `error/type` response property for the response status `400` - added the new `cannot-monetize-without-payout-billing-info` enum value to the `error/type` response property for the response status `401` - added the new `cannot-monetize-without-payout-billing-info` enum value to the `error/type` response property for the response status `403` - …3 more [Change history](https://skmtc.dev/apify/apis/apify-api/changes/v2/actors/:actorId/get.md) --- [API](https://skmtc.dev/apify/apis/apify-api.md) · [All operations](https://skmtc.dev/apify/apis/apify-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apify/apify-api/revisions/5ceb2cdfe616/schema)