FavCRM

FavCRM Loyalty and Offers API

The Loyalty and Offers API from FavCRM — 6 operation(s) for loyalty and offers.

Documentation GitHub OpenAPI

Operations 6

GET /v6/customer-portal/membership-tiers List membership tiers #

GET /v6/customer-portal/gifts/offers List gift offers #

GET /v6/customer-portal/gifts/offers/{id} Get gift offer #

POST /v6/customer-portal/gifts/offers/{id}/redeem Redeem gift offer #

POST /v6/customer-portal/gifts/claim Claim gift #

GET /v6/customer-portal/gifts/redemptions List customer gift redemptions #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/favcrm-io/openapi/favcrm-io-loyalty-and-offers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/favcrm-io:favcrm-io-loyalty-and-offers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: FavCRM Public SDK Loyalty and Offers API
  version: 0.2.0
  summary: Customer-facing v6 APIs for public FavCRM integrations.
  description: 'Curated public SDK contract for building storefront, booking, member,

    content, event, commerce, offer, and survey integrations. Provider

    callbacks, generated platform docs, MCP/OAuth discovery, health checks, and

    internal developer routes are intentionally excluded.'
servers:
- url: https://api.favcrm.io
  description: Production v6 API domain
- url: https://api.favoredapp.co
  description: Legacy production domain that can proxy v6 routes
- url: http://localhost:18778
  description: Local development gateway
tags:
- name: Loyalty and Offers
paths:
  /v6/customer-portal/membership-tiers:
    get:
      tags:
      - Loyalty and Offers
      summary: List membership tiers
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      responses:
        '200':
          $ref: '#/components/responses/ListSuccess'
      operationId: getV6CustomerPortalMembershipTiers
      x-operation-id-source: derived
  /v6/customer-portal/gifts/offers:
    get:
      tags:
      - Loyalty and Offers
      summary: List gift offers
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      responses:
        '200':
          $ref: '#/components/responses/ListSuccess'
      operationId: getV6CustomerPortalGiftsOffers
      x-operation-id-source: derived
  /v6/customer-portal/gifts/offers/{id}:
    get:
      tags:
      - Loyalty and Offers
      summary: Get gift offer
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: getV6CustomerPortalGiftsOffersById
      x-operation-id-source: derived
  /v6/customer-portal/gifts/offers/{id}/redeem:
    post:
      tags:
      - Loyalty and Offers
      summary: Redeem gift offer
      security:
      - customerBearer: []
      parameters:
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: postV6CustomerPortalGiftsOffersByIdRedeem
      x-operation-id-source: derived
  /v6/customer-portal/gifts/claim:
    post:
      tags:
      - Loyalty and Offers
      summary: Claim gift
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: postV6CustomerPortalGiftsClaim
      x-operation-id-source: derived
  /v6/customer-portal/gifts/redemptions:
    get:
      tags:
      - Loyalty and Offers
      summary: List customer gift redemptions
      security:
      - customerBearer: []
      responses:
        '200':
          $ref: '#/components/responses/ListSuccess'
      operationId: getV6CustomerPortalGiftsRedemptions
      x-operation-id-source: derived
components:
  parameters:
    CompanyIdHeader:
      name: X-Company-Id
      in: header
      required: false
      schema:
        type: string
      description: Tenant id. May be omitted when tenant context is resolved by storefront domain.
    IdPath:
      name: id
      in: path
      required: true
      schema:
        type: string
  responses:
    ListSuccess:
      description: Standard list success response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListResponse'
    Success:
      description: Standard success response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessResponse'
  schemas:
    SuccessResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          additionalProperties: true
    ListResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          properties:
            items:
              type: array
              items:
                type: object
                additionalProperties: true
            pagination:
              type: object
              additionalProperties: true
          additionalProperties: true
  securitySchemes:
    customerBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT