--- title: "List resources" method: GET path: "/v1/resources" tags: ["Resources"] --- # List resources `GET /v1/resources` Cursor-paginated list of the workspace's provider resources (durable, workspace-owned provider assets, e.g. phone numbers), newest first. Optional `provider`/`resourceType`/`state` filters (`resourceType` requires `provider`). Three listing modes: by default the page holds TOP-LEVEL resources only; `includeChildren=true` lists everything (children included) in one flat page; `parent=` lists ONLY that resource's children. ## Query parameters - `limit` integer — Max items per page (server-side cap applies). - `cursor` string — Cursor returned by the previous page. - `provider` 'apify' | 'pdl' | 'opoint' | 'tikhub' | 'exa' | 'minimax' | 'bytedance' | 'suzanne' | 'akta' | 'saperly' | 'apollo' | 'censusdata.xyz' | 'defillama' | 'sfs' | 'semrush' | 'elevenlabs' | 'octen' | 'mint' | 'context.dev' | 'surf' | 'agentmail' | 'ahrefs' | 'tinyfish' | 'firecrawl' | 'massive' | 'hunterio' | 'contactout' | 'clay' | 'alibaba' | 'mrscraper' | 'fundable' | 'ploid' | 'smolmachine' | 'kling' | 'recall' | 'gemini' | 'tendata' | 'openai' | 'vaquill' | 'litescrape' | 'typesafe' | 'dataforseo' | 'orbit' | 'cloro' | 'topaz' | 'search1api' | 'magichour' — Filter by provider slug (e.g. 'saperly'). - `resourceType` 'phone_number' | 'file_system' | 'asset_library' | 'machine' | 'email_account' | 'email_inbox' | 'email_domain' | 'browser_session' | 'browser_profile' — Filter by resource type — requires `provider` (store SK prefix is ordered). - `state` 'READY' | 'PROVISIONING' | 'ACTIVE' | 'EXPIRING' | 'SUSPENDED' | 'RELEASED' | 'PROVISION_FAILED' — Filter by lifecycle state. - `parent` string — List ONLY the children of this resource (e.g. an email account's inboxes) instead of the workspace's top-level resources. 404 when the resource is not yours. Mutually exclusive with `includeChildren`. - `includeChildren` 'true' | 'false' — Include child resources (e.g. the inboxes inside an email account) in the flat workspace listing. Default: top-level resources only. Mutually exclusive with `parent`. ## Response `200` Resources page - object - `items` Resource[], required - `resourceId` string, required — Resource identifier (ULID). - `provider` string, required - `providerName` string - `resourceSlug` string, required - `resourceType` string, required - `externalId` string, required - `identifier` string, required - `releasable` boolean, required - `state` 'READY' | 'PROVISIONING' | 'ACTIVE' | 'EXPIRING' | 'SUSPENDED' | 'RELEASED' | 'PROVISION_FAILED', required — Lifecycle state. - `provisionedBy` string, required - `releasedBy` string - `renewal` ResourceRenewal - `price` Price, required — User-facing price (markup applied). - `type` string, required - `amount` object, required - `value` number, required - `currency` 'USD', required - `flatFee` object - `value` number, required - `currency` 'USD', required - `period` object - `unit` 'MINUTE' | 'DAY' | 'MONTH', required - `count` integer, required - `per` union - object - `unit` 'MINUTE' | 'DAY' | 'MONTH', required - `count` integer, required - number - `unit` 'token' | 'character' | 'second' | 'image' | 'credit' | 'result' | 'gb-month' | 'step' - `default` union - object - `type` 'PER_CALL', required - `amount` object, required - … - object - `type` 'PER_RESULT', required - `amount` object, required - … - `flatFee` object - … - object - `type` 'METERED', required - `amount` object, required - … - `per` object, required - … - object - `type` 'PER_UNIT', required - `amount` object, required - … - `per` number, required - `unit` 'token' | 'character' | 'second' | 'image' | 'credit' | 'result' | 'gb-month' | 'step', required - `selectors` object[] - `label` string, required - `key` string, required - `in` 'body' | 'queryParam' | 'pathParam' | 'output', required - `offset` integer - `variants` object[] - `when` object, required - `price` union, required - object - … - object - … - object - … - object - … - `label` string - `tiers` object[] - `label` string, required - `when` object - `selector` object - `label` string, required - `key` string, required - `in` 'body' | 'queryParam' | 'pathParam' | 'output', required - `offset` integer - `price` union, required - object - … - object - … - object - … - object - … - `notes` string[] - `renewLead` object, required — How long before `currentPeriodEnd` charging starts. - `unit` string, required - `count` number, required - `startedAt` string, date-time, required - `currentPeriodStart` string, date-time, required - `currentPeriodEnd` string, date-time, required - `renewAttemptAt` string, date-time, required - `cycle` number, required - `lastAttempt` object - `at` string, date-time, required - `outcome` 'SUCCEEDED' | 'FAILED', required - `reason` string - `cancelledAt` string, date-time - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `releasedAt` string, date-time - `releaseReasonCode` string - `releaseReason` string - `phoneNumber` string - `country` string - `numberType` string - `name` string - `totalBytes` integer - `objectCount` integer - `lastMutationAt` string, date-time - `cdpUrl` string - `baseUrl` string - `targetUrl` string - `timeoutSeconds` integer - `proxyCountryCode` string - `externalResources` ExternalResourceSummary[] - `kind` string, required - `displayName` string, required - `label` string - `syncedAt` string, date-time - `usageBilling` object — Metered usage pricing (absent for rent-only resources). - `rateCard` object[], required — One line per term of the metered price function. - `label` string, required — The metered dimension ("cpu", "storage", …). - `ratePerUnit` number, required — The dollar rate per unit (e.g. 0.05). - `per` string, required — The unit the rate applies to ("vCPU·hour", "GB·month", …). - `cursor` string — Opaque cursor for the next page; absent on the last page. ## Other responses - `400` — Bad request — input failed validation - `401` — Unauthorized — missing or invalid credentials - `403` — Forbidden — caller has no workspace or no access - `404` — Parent resource not found - `500` — Internal server error ## Changes - **2026-09-27** `99cc8f5bdff4` — 4 info - added the new enum value `dataforseo` to the `query` request parameter `provider` - added the new enum value `magichour` to the `query` request parameter `provider` - added the new enum value `search1api` to the `query` request parameter `provider` - added the new enum value `topaz` to the `query` request parameter `provider` - **2026-09-25** `5abada71ceae` — 65 warning, 1 info - added the new `IDENTITY_ALREADY_LINKED` enum value to the `errorCode` response property for the response status `400` - added the new `IDENTITY_ALREADY_LINKED` enum value to the `errorCode` response property for the response status `401` - added the new `IDENTITY_ALREADY_LINKED` enum value to the `errorCode` response property for the response status `403` - added the new `IDENTITY_ALREADY_LINKED` enum value to the `errorCode` response property for the response status `404` - …62 more - **2026-09-23** `fadab791136c` — 9 warning, 13 info - added the new `X402_UNBOUNDED_PRICE` enum value to the `errorCode` response property for the response status `400` - added the new `X402_UNBOUNDED_PRICE` enum value to the `errorCode` response property for the response status `401` - added the new `X402_UNBOUNDED_PRICE` enum value to the `errorCode` response property for the response status `403` - added the new `X402_UNBOUNDED_PRICE` enum value to the `errorCode` response property for the response status `404` - …18 more - …earlier changes not shown [Full history](https://skmtc.dev/monid/apis/monid-api/changes/v1/resources/get.md) --- [API](https://skmtc.dev/monid/apis/monid-api.md) · [All operations](https://skmtc.dev/monid/apis/monid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/monid/apis/monid-api/revisions/99cc8f5bdff4?raw)