Smartrr

Smartrr Subscribers API

Customer relationships (subscribers) - the Shopify customers who hold subscriptions, their payment methods, loyalty points, and referral links.

Documentation GitHub OpenAPI

Business capability

Customer Relationship Management BC-420

Operations 7

GET /vendor/customer-relationship Get Customer Relationship #

GET /vendor/customer-relationship/{customerShopifyId} Get Customer Relationship by Shopify ID #

GET /vendor/customer-relationship/{customerRelationshipId}/payment-methods Get Payment methods #

GET /vendor/customer-relationship/{customerShopifyId}/referral-link Get customer referral code and link #

PUT /vendor/customer-relationship/{customerRelationshipId}/orgPoints Add loyalty points to customer #

POST /vendor/customer-relationship/import Import Customer Relationship from Shopify Customer #

GET /vendor/customer/{custRelId}/orders Get Orders by customer ID #

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/smartrr:smartrr-subscribers-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: Smartrr Vendor Subscribers API
  description: The Smartrr Vendor API is the programmatic surface behind Smartrr, a subscription and loyalty platform for Shopify DTC brands.
  version: 1.0.0
  contact:
    name: Smartrr
    url: https://smartrr.com
servers:
- url: https://api.smartrr.com
  description: Smartrr production
security:
- smartrrAccessToken: []
tags:
- name: Subscribers
  description: Customer relationships (subscribers) - the Shopify customers who hold subscriptions, their payment methods, loyalty points, and referral links.
paths:
  /vendor/customer-relationship:
    get:
      tags:
      - Subscribers
      summary: Get Customer Relationship
      description: List subscribers (customer relationships) for the organization.
      operationId: getCustomerRelationships
      responses:
        '200':
          description: A paginated list of customer relationships.
  /vendor/customer-relationship/{customerShopifyId}:
    get:
      tags:
      - Subscribers
      summary: Get Customer Relationship by Shopify ID
      operationId: getCustomerRelationshipByShopifyId
      parameters:
      - name: customerShopifyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A single customer relationship.
  /vendor/customer-relationship/{customerRelationshipId}/payment-methods:
    get:
      tags:
      - Subscribers
      summary: Get Payment methods
      operationId: getPaymentMethods
      parameters:
      - name: customerRelationshipId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The customer's payment methods.
  /vendor/customer-relationship/{customerShopifyId}/referral-link:
    get:
      tags:
      - Subscribers
      summary: Get customer referral code and link
      operationId: getReferralLink
      parameters:
      - name: customerShopifyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The customer's referral code and link.
  /vendor/customer-relationship/{customerRelationshipId}/orgPoints:
    put:
      tags:
      - Subscribers
      summary: Add loyalty points to customer
      operationId: addLoyaltyPoints
      parameters:
      - name: customerRelationshipId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The updated loyalty points balance.
  /vendor/customer-relationship/import:
    post:
      tags:
      - Subscribers
      summary: Import Customer Relationship from Shopify Customer
      operationId: importCustomerRelationship
      responses:
        '200':
          description: The imported customer relationship.
  /vendor/customer/{custRelId}/orders:
    get:
      tags:
      - Subscribers
      summary: Get Orders by customer ID
      operationId: getOrdersByCustomer
      parameters:
      - name: custRelId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Orders for the customer.
components:
  securitySchemes:
    smartrrAccessToken:
      type: apiKey
      in: header
      name: x-smartrr-access-token
      description: Per-organization API access token generated in the Smartrr admin under the Integrations tab (Add Key). Sent on every request in the x-smartrr-access-token header.