Skip to main content
GET
/
offers
List offers in workspace
curl --request GET \
  --url https://api.akua.dev/v1/offers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "short_hash": "aB3xK9pQ",
      "package_id": "<string>",
      "package_version_id": "<string>",
      "created_at": 1,
      "workspace_id": "<string>",
      "target_workspace_id": "<string>",
      "created_by": "<string>",
      "product_id": "<string>",
      "input_schema": "<unknown>",
      "allowed_emails": [
        "<string>"
      ],
      "field_values": {},
      "tier": "<string>",
      "region_id": "<string>",
      "cluster_id": "<string>",
      "offer_channel_id": "<string>",
      "requested_policy_snapshot": {
        "offer_channel_id": "<string>",
        "channel_policy_id": "<string>",
        "channel_policy_version": 123,
        "approval_required": true,
        "checkout_required": true,
        "support_scope": {
          "visibility": []
        },
        "pricing_summary": {
          "unit_amount": 1
        },
        "blocking_reasons": []
      },
      "approved_policy_snapshot": {
        "offer_channel_id": "<string>",
        "channel_policy_id": "<string>",
        "channel_policy_version": 123,
        "approval_required": true,
        "checkout_required": true,
        "support_scope": {
          "visibility": []
        },
        "pricing_summary": {
          "unit_amount": 1
        },
        "blocking_reasons": []
      },
      "notes": "<string>",
      "expires_at": 1,
      "max_uses": 123,
      "used_count": 1,
      "archived_at": 1,
      "updated_at": 1,
      "etag": "<string>",
      "product_name": "<string>",
      "image_url": "<string>",
      "seller_name": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://akua-1dce587a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

​
akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

Query Parameters

​
cursor
string

Pagination cursor from a previous response's next_cursor.

​
limit
integer
default:50

Items per page (1-100, default 50)

Required range: 1 <= x <= 100
Example:

50

Response

List of offers

​
data
object[]
required
​
has_more
boolean
required

True if more items exist after this page.

​
next_cursor
string | null
required

Opaque cursor for the next page, or null if no more pages.