---
title: "Get a resource"
method: GET
path: "/v1/resources/{resourceId}"
tags: ["Resources"]
---

# Get a resource

`GET /v1/resources/{resourceId}`

Get a single workspace-owned resource. External detail is a separate on-demand live fetch — see GET /v1/resources/{resourceId}/external/{kind}.

## Path parameters

- `resourceId` string, required — Resource identifier (ULID).

## Response `200`

The resource

- Resource
  - `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
            - `value` number, required
            - `currency` 'USD', required
        - object
          - `type` 'PER_RESULT', required
          - `amount` object, required
            - `value` number, required
            - `currency` 'USD', required
          - `flatFee` object
            - `value` number, required
            - `currency` 'USD', required
        - object
          - `type` 'METERED', required
          - `amount` object, required
            - `value` number, required
            - `currency` 'USD', required
          - `per` object, required
            - `unit` 'MINUTE' | 'DAY' | 'MONTH', required
            - `count` integer, required
        - object
          - `type` 'PER_UNIT', required
          - `amount` object, required
            - `value` number, required
            - `currency` 'USD', 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
            - `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
        - `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
            - `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
      - `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", …).

## Other responses

- `401` — Unauthorized — missing or invalid credentials
- `403` — Forbidden — caller has no workspace or no access
- `404` — Resource not found
- `500` — Internal server error

## Changes

- **2026-09-23** `fadab791136c` — 8 warning, 6 info
  - 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`
  - added the new `X402_UNBOUNDED_PRICE` enum value to the `errorCode` response property for the response status `500`
  - …10 more
- **2026-09-18** `cb05b702253d` — 4 warning
  - added the new `gb-month` enum value to the `renewal/price/default/anyOf[subschema #4]/unit` response property for the response status `200`
  - added the new `gb-month` enum value to the `renewal/price/tiers/items/price/anyOf[subschema #4]/unit` response property for the response status `200`
  - added the new `gb-month` enum value to the `renewal/price/unit` response property for the response status `200`
  - added the new `gb-month` enum value to the `renewal/price/variants/items/price/anyOf[subschema #4]/unit` response property for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/monid/apis/monid-api/changes/v1/resources/:resourceId/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/fadab791136c?raw)
