Skip to main content
GET
/
programs
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "website": "<string>",
      "landingPageUrl": "<string>",
      "portalSlug": "<string>",
      "portalTheme": "classic",
      "status": "active",
      "marketplaceStatus": "private",
      "marketplaceCategory": "<string>",
      "marketplaceDescription": "<string>",
      "marketplaceLogoUrl": "<string>",
      "commissionType": "one_time",
      "commissionPercent": 123,
      "commissionLimitMonths": 123,
      "commissionHoldDays": 123,
      "cookieDuration": 123,
      "trackingRequiresConsent": true,
      "trackingParamAliases": [
        "<string>"
      ],
      "payoutThreshold": 123,
      "payoutFrequency": "weekly",
      "currency": "<string>",
      "autoApproveAffiliates": true,
      "termsUrl": "<string>",
      "stripeAccountId": "<string>",
      "stripeAccountDisplayName": "<string>",
      "stripeConnectedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "pageSize": 123,
    "hasMore": true,
    "requestId": "<string>",
    "nextCursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Use API key as Bearer token, for example: Bearer ak_live_xxx

Query Parameters

cursor
string
limit
integer
Required range: 1 <= x <= 100
page
integer
Required range: x >= 1
pageSize
integer
Required range: 1 <= x <= 100
offset
integer
Required range: x >= 0
status
enum<string>
Available options:
active,
paused,
archived

Response

Programs list

data
object[]
required
meta
object
required