> ## Documentation Index > Fetch the complete documentation index at: https://docs.akua.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get offer details > Returns the full offer record including pre-fill values and email allowlist. Caller must be a member of the offer’s workspace. ## OpenAPI ````yaml /openapi-public.json get /offers/{id} openapi: 3.1.0 info: title: Akua API version: 1.0.0 description: >- Public API for managing Akua workspaces, clusters, products, and installs. Authenticate with a workspace API token via the `Authorization: Bearer sk_akua_...` header. A workspace-owned token implies its workspace. Broad tokens select the active workspace via the optional `Akua-Context` header. contact: name: Akua API support email: support@akua.dev url: https://akua.dev/docs servers: - url: https://api.akua.dev/v1 description: Production security: [] tags: - name: Auth description: Authentication and token management. - name: Agents description: Agent identities and configuration. - name: Agent sessions description: Durable agent conversations and tasks. - name: Agent turns description: Submitted agent work and event emission. - name: Agent events description: Normalized agent event history and streams. - name: Custom domains description: Workspace custom domains and routing targets. - name: Cloudflare description: Cloudflare account credentials and gateway control. - name: Clusters description: Kubernetes clusters and cluster access operations. - name: ComputeConfigs description: Workspace compute provider configurations. - name: Entitlements description: Effective workspace capabilities and limits. - name: Dashboards description: Dashboard and widget resources. - name: Installs description: Installation and render operations. - name: Machines description: Compute machines and lifecycle events. - name: Notifications description: User notification state. - name: Offer Channels description: Private offer channels and policy versions. - name: Offers description: Marketplace offers and redemption tracking. - name: Operations description: Long-running operation status and controls. - name: Order Drafts description: Draft checkout orders and checkout sessions. - name: Organizations description: Organizations, memberships, and managed workspaces. - name: Packages description: Software packages, versions, and input schemas. - name: Products description: Marketplace product catalog resources. - name: Preview hostnames description: Install preview hostnames and routing state. - name: Quotas description: Workspace quota limits and usage. - name: Regions description: Available deployment regions. - name: Registry description: Container registry credentials and repositories. - name: Repository change requests description: Fork-backed repository change reviews and lifecycle actions. - name: Repositories description: Source repositories available to the workspace. - name: Secrets description: Workspace secrets and secret versions. - name: Snippets description: Reusable snippets and snippet runs. - name: Workspace subdomains description: Workspace subdomain identity. - name: Workspaces description: Workspace resources, members, and billing state. paths: /offers/{id}: get: tags: - Offers summary: Get offer details description: >- Returns the full offer record including pre-fill values and email allowlist. Caller must be a member of the offer’s workspace. operationId: offers.get parameters: - schema: type: string minLength: 1 maxLength: 56 description: Offer ID example: offer_j572abc... required: true description: Offer ID name: id in: path responses: '200': description: Offer details content: application/json: schema: $ref: '#/components/schemas/Offer' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' security: - BearerAuth: [] components: schemas: Offer: type: object properties: id: type: string minLength: 1 maxLength: 56 description: Offer ID short_hash: type: string description: >- 8-char base62 code that appears in the customer-clicked URL `/i/` example: aB3xK9pQ workspace_id: type: string minLength: 1 maxLength: 53 description: Workspace ID target_workspace_id: type: string minLength: 1 maxLength: 53 description: >- Optional workspace that receives the offer outcome when visible to the caller created_by: type: string description: User ID of the seller who issued the offer product_id: type: string minLength: 1 maxLength: 55 description: Product ID package_id: type: string minLength: 1 maxLength: 54 description: Package ID package_version_id: type: string minLength: 1 maxLength: 55 description: Package version ID — pinned at create time input_schema: type: object additionalProperties: {} description: >- JSON Schema 2020-12 with x-ui extensions for the pinned package version. Present on customer resolve responses so the install wizard can render the configure step. allowed_emails: type: array items: type: string description: >- Empty / omitted = anyone authed can claim. Non-empty = the customer's verified email must match. Only returned to authed callers. field_values: type: object additionalProperties: type: object properties: value: description: Pre-fill value for this schema property locked: type: boolean description: >- When true the customer cannot override; submit ignores client value required: - value - locked description: >- Seller pre-fills keyed by package input-schema property name. Only returned to authed callers whose email matches the allowlist. tier: type: string description: Suggested billing tier region_id: type: string minLength: 1 maxLength: 54 description: Region pin cluster_id: type: string minLength: 1 maxLength: 54 description: Cluster pin offer_channel_id: type: string minLength: 1 maxLength: 54 description: Offer Channel that resolved private-offer policy for this offer commercial_mode: $ref: '#/components/schemas/CommercialMode' approval_state: $ref: '#/components/schemas/OfferApprovalState' requested_policy_snapshot: $ref: '#/components/schemas/OfferPolicySnapshot' approved_policy_snapshot: $ref: '#/components/schemas/OfferPolicySnapshot' notes: type: string expires_at: type: integer minimum: 0 description: Unix timestamp (seconds) max_uses: type: integer exclusiveMinimum: 0 order_ttl_minutes: type: integer exclusiveMinimum: 0 maximum: 1440 description: >- Per-redemption order TTL in minutes. Defaults to 120; capped at 1440 (24h). used_count: type: integer minimum: 0 archived_at: type: integer minimum: 0 description: Unix timestamp (seconds) status: $ref: '#/components/schemas/OfferStatus' created_at: type: integer minimum: 0 description: Unix timestamp (seconds) updated_at: type: integer minimum: 0 description: Unix timestamp (seconds) etag: type: string product_name: type: string description: Display name of the offered product image_url: type: string description: Logo or icon URL for the customer landing page seller_name: type: string description: Display name of the seller who issued this offer required: - id - short_hash - package_id - package_version_id - status - created_at ApiErrorResponse: type: object properties: success: type: boolean enum: - false errors: type: array items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object properties: {} description: Always empty for error responses required: - success - errors - result CommercialMode: type: string enum: - paid - non_billable_test description: >- Customer commercial path requested for an offer. `paid` routes through checkout when policy requires it; `non_billable_test` creates a non-billable test offer when policy allows it. OfferApprovalState: type: string enum: - not_required - pending - approved - rejected OfferPolicySnapshot: type: object properties: offer_channel_id: type: string minLength: 1 maxLength: 54 channel_policy_id: type: string minLength: 1 maxLength: 56 channel_policy_version: type: integer exclusiveMinimum: 0 commercial_mode: $ref: '#/components/schemas/CommercialMode' approval_required: type: boolean checkout_required: type: boolean pricing_summary: $ref: '#/components/schemas/OfferPricingSummary' support_scope: $ref: '#/components/schemas/OfferSupportScope' blocking_reasons: type: array items: type: string default: [] required: - offer_channel_id - channel_policy_id - channel_policy_version - commercial_mode - approval_required - checkout_required - support_scope OfferStatus: type: string enum: - active - archived - expired - redeemed description: Computed lifecycle status — never set directly; derived from row state. ApiErrorEntry: type: object properties: code: type: integer example: 7002 description: Machine-readable error code message: type: string example: Resource not found description: Human-readable error message path: type: array items: type: string example: - body - name description: Field path that caused the error, when applicable metadata: type: object additionalProperties: type: string required: - code - message OfferPricingSummary: type: object properties: currency: type: string enum: - eur - usd unit_amount: type: integer minimum: 0 interval: $ref: '#/components/schemas/PricingInterval' source: type: string enum: - channel_policy - request required: - currency - unit_amount - interval - source OfferSupportScope: type: object properties: type: type: string enum: - scoped_support_relationship visibility: type: array items: type: string enum: - install_state - app_urls maxItems: 20 required: - type - visibility additionalProperties: false PricingInterval: type: string enum: - month - year securitySchemes: BearerAuth: type: http scheme: bearer description: >- workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens ````