Get referral reward rules

GET /v1/admin/catalog/referral-rules

• Operation ID: getCatalogReferralRules
• Tags: Catalog: referral rules
• Base URL: http://localhost:8787

Reads the published and draft credits site settings.

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission site.read.

Authentication

• Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
• Required permissions: site.read

Responses

200

Referral rules.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (CatalogReferralRules)

Field	Type	Required	Description
referral_reward_credits	number	yes	Currently published reward.
draft_referral_reward_credits	number	yes	Value in the pending draft.
published_version	integer	yes	-
published_at	string | null	yes	-

Errors

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

403

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "forbidden",
  "details": {
    "perm": "site.read"
  }
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

Examples

curl

curl -X GET 'http://localhost:8787/v1/admin/catalog/referral-rules' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/catalog/referral-rules", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();