> ## Documentation Index > Fetch the complete documentation index at: https://monid.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # List 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. ## OpenAPI ````yaml https://monid.ai/openapi.json get /v1/resources openapi: 3.1.0 info: title: Monid API version: 0.1.0 description: >- Agentic payment platform for data — agents discover and buy data on demand. Authenticated `/v1/*` routes accept a Monid API key or Clerk JWT as a Bearer token. All errors return `{ code, message }`. List endpoints use cursor pagination; consult each operation schema for its last-page cursor encoding. servers: - url: https://api.monid.ai description: Production - url: https://monid.ai description: Public registry alias (public/v1 only) security: [] paths: /v1/resources: get: tags: - Resources summary: List resources description: >- 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. parameters: - schema: type: integer exclusiveMinimum: 0 maximum: 100 description: Max items per page (server-side cap applies). required: false description: Max items per page (server-side cap applies). name: limit in: query - schema: type: string description: Cursor returned by the previous page. required: false description: Cursor returned by the previous page. name: cursor in: query - schema: type: string enum: - 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 - agentline - keenable - datalegion - channel3 - anyapi - fishaudio - serpapi - stepfun - twitterdata.io - tavily - heygen - appllama - parallel - lev8 - velabreakout description: Filter by provider slug (e.g. 'saperly'). required: false description: Filter by provider slug (e.g. 'saperly'). name: provider in: query - schema: type: string enum: - phone_number - file_system - asset_library - machine - email_account - email_inbox - email_domain - browser_session - browser_profile - voice description: >- Filter by resource type — requires `provider` (store SK prefix is ordered). required: false description: >- Filter by resource type — requires `provider` (store SK prefix is ordered). name: resourceType in: query - schema: type: string enum: - READY - PROVISIONING - ACTIVE - EXPIRING - SUSPENDED - RELEASED - PROVISION_FAILED description: Filter by lifecycle state. required: false description: Filter by lifecycle state. name: state in: query - schema: type: string minLength: 1 description: >- 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`. required: false description: >- 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`. name: parent in: query - schema: type: string enum: - 'true' - 'false' description: >- 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`. required: false description: >- 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`. name: includeChildren in: query - $ref: '#/components/parameters/AgentModelHeader' - $ref: '#/components/parameters/AgentHarnessHeader' - $ref: '#/components/parameters/AgentSessionIdHeader' responses: '200': description: Resources page content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/Resource' cursor: type: string description: Opaque cursor for the next page; absent on the last page. required: - items '400': description: Bad request — input failed validation content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized — missing or invalid credentials content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden — caller has no workspace or no access content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Parent resource not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Rate limited (errorCode `RATE_LIMITED`, message `Rate limited. Retry after Ns.`) — the `Retry-After` header carries whole seconds until the caller may retry; `RateLimit-Limit/-Remaining/-Reset` describe the binding limit as numbers only (also sent on allowed responses that matched a rule; responses that matched no rule, or an `unlimited` exemption, carry none of them). Applies to every authenticated `/v1` route (per API key / user / workspace); POST /v1/run additionally enforces per-provider/endpoint run limits. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' security: - Bearer: - resources:read components: parameters: AgentModelHeader: name: X-Monid-Agent-Model in: header required: false description: >- Model driving the calling agent. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error). schema: type: string maxLength: 256 example: claude-opus-5-5 AgentHarnessHeader: name: X-Monid-Agent-Harness in: header required: false description: >- Agent harness or client making the call (e.g. a coding agent, an agent framework). Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error). schema: type: string maxLength: 256 example: claude-code AgentSessionIdHeader: name: X-Monid-Agent-Session-Id in: header required: false description: >- Caller-side session identifier, so the calls of one agent session (discover → inspect → run → polling) can be correlated. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error). schema: type: string maxLength: 256 example: 01JABCDEF0123456789XYZ schemas: Resource: type: object properties: resourceId: type: string description: Resource identifier (ULID). provider: type: string providerName: type: string resourceSlug: type: string resourceType: type: string displayName: type: string description: Resource display name (e.g. "Machine"). description: type: string description: Short one-line description. summary: type: string description: Detailed description. externalId: type: string identifier: type: string releasable: type: boolean state: type: string enum: - READY - PROVISIONING - ACTIVE - EXPIRING - SUSPENDED - RELEASED - PROVISION_FAILED description: Lifecycle state. provisionedBy: type: string releasedBy: type: string renewal: $ref: '#/components/schemas/ResourceRenewal' createdAt: type: string format: date-time updatedAt: type: string format: date-time releasedAt: type: string format: date-time releaseReasonCode: type: string releaseReason: type: string phoneNumber: type: string country: type: string numberType: type: string name: type: string totalBytes: type: integer objectCount: type: integer lastMutationAt: type: string format: date-time expiresAt: type: string ttl: type: number activityTtl: type: number profileId: type: string profileSaveChanges: type: boolean liveViewUrl: type: string interactiveLiveViewUrl: type: string cdpUrl: type: string baseUrl: type: string targetUrl: type: string timeoutSeconds: type: integer proxyCountryCode: type: string externalResources: type: array items: $ref: '#/components/schemas/ExternalResourceSummary' syncedAt: type: string format: date-time usageBilling: type: object properties: rateCard: type: array items: type: object properties: label: type: string description: The metered dimension ("cpu", "storage", …). ratePerUnit: type: number description: The dollar rate per unit (e.g. 0.05). per: type: string description: The unit the rate applies to ("vCPU·hour", "GB·month", …). required: - label - ratePerUnit - per description: One line per term of the metered price function. required: - rateCard description: Metered usage pricing (absent for rent-only resources). required: - resourceId - provider - resourceSlug - resourceType - externalId - identifier - releasable - state - provisionedBy - createdAt - updatedAt Error: type: object properties: code: type: integer description: HTTP status code, duplicated in the body. example: 400 message: type: string description: Human-readable error description. example: Bad Request hints: type: object additionalProperties: anyOf: - type: string - type: object properties: kind: type: string enum: - command - discover - inspect - run - getRun - stop - releaseResource - topup command: type: string query: type: string provider: type: string endpoint: type: string runId: type: string resourceId: type: string stripe: type: string dashboard: type: string docs: type: string comment: type: string required: - kind description: >- Optional next actions, rendered for the calling client like run-response hints (e.g. the paid TinyFish version on a free-quota 429 — spending permission required). errorCode: type: string enum: - RATE_LIMITED - X402_WORKSPACE_RESOURCES - X402_WORKSPACE_ONLY - X402_ACCRUING_COST - X402_EXCEEDS_SETTLEMENT_WINDOW - X402_VALIDITY_WINDOW_TOO_SHORT - X402_UNBOUNDED_PRICE - X402_PROMOTION - INSUFFICIENT_SCOPE - WALLET_INSUFFICIENT_FUNDS - IDENTITY_PROVIDER_UNKNOWN - IDENTITY_LINK_REQUIRES_SESSION - IDENTITY_LINK_STATE_INVALID - IDENTITY_VERIFICATION_FAILED - IDENTITY_PROVIDER_UNAVAILABLE - IDENTITY_ALREADY_LINKED - IDENTITY_USER_ALREADY_LINKED - IDENTITY_LINK_RATE_LIMITED - IDENTITY_REQUIRED - PROMO_IDENTITY_REDEEMED - PROMO_REDEEM_REQUIRES_SESSION - PROMO_CODE_REDEEMED_BY_WORKSPACE - PROMO_CODE_REDEEMED_BY_USER description: >- OPTIONAL machine-readable discriminant from the documented `ApiErrorCode` registry. Absent on legacy errors; clients MUST treat unknown values as absent. required: - code - message ResourceRenewal: type: object properties: price: $ref: '#/components/schemas/Price' renewLead: type: object properties: unit: type: string count: type: number required: - unit - count description: How long before `currentPeriodEnd` charging starts. startedAt: type: string format: date-time currentPeriodStart: type: string format: date-time currentPeriodEnd: type: string format: date-time renewAttemptAt: type: string format: date-time cycle: type: number lastAttempt: type: object properties: at: type: string format: date-time outcome: type: string enum: - SUCCEEDED - FAILED reason: type: string required: - at - outcome cancelledAt: type: string format: date-time required: - price - renewLead - startedAt - currentPeriodStart - currentPeriodEnd - renewAttemptAt - cycle ExternalResourceSummary: type: object properties: kind: type: string displayName: type: string label: type: string required: - kind - displayName Price: type: object properties: type: type: string amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency flatFee: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency period: type: object properties: unit: type: string enum: - MINUTE - DAY - MONTH count: type: integer exclusiveMinimum: 0 required: - unit - count per: anyOf: - type: object properties: unit: type: string enum: - MINUTE - DAY - MONTH count: type: integer exclusiveMinimum: 0 required: - unit - count - type: number unit: type: string enum: - token - character - second - image - credit - result - gb-month - step - byte - url - page default: anyOf: - type: object properties: type: type: string enum: - PER_CALL amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency required: - type - amount - type: object properties: type: type: string enum: - PER_RESULT amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency flatFee: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency required: - type - amount - type: object properties: type: type: string enum: - METERED amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency per: type: object properties: unit: type: string enum: - MINUTE - DAY - MONTH count: type: integer exclusiveMinimum: 0 required: - unit - count required: - type - amount - per - type: object properties: type: type: string enum: - PER_UNIT amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency per: type: number unit: type: string enum: - token - character - second - image - credit - result - gb-month - step - byte - url - page required: - type - amount - per - unit selectors: type: array items: type: object properties: label: type: string key: type: string in: type: string enum: - body - queryParam - pathParam - output offset: type: integer minimum: 0 required: - label - key - in variants: type: array items: type: object properties: when: type: object additionalProperties: anyOf: - type: string - type: number - type: boolean price: anyOf: - type: object properties: type: type: string enum: - PER_CALL amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency required: - type - amount - type: object properties: type: type: string enum: - PER_RESULT amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency flatFee: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency required: - type - amount - type: object properties: type: type: string enum: - METERED amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency per: type: object properties: unit: type: string enum: - MINUTE - DAY - MONTH count: type: integer exclusiveMinimum: 0 required: - unit - count required: - type - amount - per - type: object properties: type: type: string enum: - PER_UNIT amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency per: type: number unit: type: string enum: - token - character - second - image - credit - result - gb-month - step - byte - url - page required: - type - amount - per - unit label: type: string required: - when - price tiers: type: array items: type: object properties: label: type: string when: type: object additionalProperties: anyOf: - type: string - type: number - type: boolean selector: type: object properties: label: type: string key: type: string in: type: string enum: - body - queryParam - pathParam - output offset: type: integer minimum: 0 required: - label - key - in price: anyOf: - type: object properties: type: type: string enum: - PER_CALL amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency required: - type - amount - type: object properties: type: type: string enum: - PER_RESULT amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency flatFee: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency required: - type - amount - type: object properties: type: type: string enum: - METERED amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency per: type: object properties: unit: type: string enum: - MINUTE - DAY - MONTH count: type: integer exclusiveMinimum: 0 required: - unit - count required: - type - amount - per - type: object properties: type: type: string enum: - PER_UNIT amount: type: object properties: value: type: number currency: type: string enum: - USD required: - value - currency per: type: number unit: type: string enum: - token - character - second - image - credit - result - gb-month - step - byte - url - page required: - type - amount - per - unit required: - label - price notes: type: array items: type: string required: - type - amount description: User-facing price (markup applied). securitySchemes: Bearer: type: http scheme: bearer description: >- Monid API key (`Authorization: Bearer mk_...`) or Clerk-issued JWT. Each operation lists the ONE scope an API key needs. `{resource}:*` grants every action on that resource; `*` grants everything; Clerk sessions hold `*`. Operations with an empty list need no scope. Scope catalog: `GET /v1/api-keys/scopes`. x-aep-authentication-method: api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.