Recurly

Recurly Paths API

The Paths API from Recurly — 5 operation(s) for paths.

Documentation GitHub OpenAPI

Operations 5

GET /paths/{path_id}/impression Impression API #

GET /paths/{path_id}/dismiss Dismiss API #

GET /paths/{path_id}/goal Goal API #

GET /paths/{path_id}/holdout Holdout API #

GET /paths/goal_reset_all Reset API #

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/recurly:recurly-paths-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: Recurly Paths API
  version: '100.7'
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  description: 'Operations tagged Paths across 2 of this provider''s published API definitions: recurly-engage-custom-rendering-api.yaml, recurly-engage-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://conduit.redfast.com
security:
- sec0: []
tags:
- name: Paths
paths:
  /paths/{path_id}/impression:
    get:
      summary: Impression API
      description: ''
      operationId: impression-api
      parameters:
      - name: user-id
        in: header
        description: Unique identifier for the unauthenticated user
        schema:
          type: string
          default: test-user
      - name: anonymous-user-id
        in: header
        description: Unique authenticated identifier for the user
        schema:
          type: string
          default: anon-123
      - name: device_type
        in: query
        description: Accepted values are web, roku_os, ios, tv_os, android_os (additional values for custom devices may be specified). Defaults to web if not specified.
        schema:
          type: string
      - name: action_group_id
        in: query
        description: Value from Path object returned from Ping API
        schema:
          type: string
      - name: trigger_id
        in: query
        description: (optional) ID of the trigger utilized to invoke the impression
        schema:
          type: string
      - name: path_id
        in: path
        description: ID from Path object returned from Ping API
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"success\": true,\n  \"configs\": { \"ping_frequency\": 10 }\n}"
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    default: true
                  configs:
                    type: object
                    properties:
                      ping_frequency:
                        type: integer
                        example: 10
                        default: 0
      deprecated: false
      security: []
      tags:
      - Paths
    servers:
    - url: https://conduit.redfast.com
  /paths/{path_id}/dismiss:
    get:
      summary: Dismiss API
      description: ''
      operationId: dismiss-api
      parameters:
      - name: path_id
        in: path
        description: ID from Path object returned from Ping API
        schema:
          type: string
        required: true
      - name: click
        in: query
        description: Accepted values are dismiss, timeout, decline
        schema:
          type: string
      - name: device_type
        in: query
        description: Accepted values are web, roku_os, ios, tv_os, android_os (additional values for custom devices may be specified). Defaults to web if not specified.
        schema:
          type: string
      - name: action_group_id
        in: query
        description: Value from Path object returned from Ping API
        schema:
          type: string
      - name: user-id
        in: header
        description: Unique identifier for the unauthenticated user
        schema:
          type: string
      - name: anonymous-user-id
        in: header
        description: Unique authenticated identifier for the user
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"success\": true,\n  \"configs\": { \"ping_frequency\": 10 }\n}"
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    default: true
                  configs:
                    type: object
                    properties:
                      ping_frequency:
                        type: integer
                        example: 10
                        default: 0
      deprecated: false
      security: []
      tags:
      - Paths
    servers:
    - url: https://conduit.redfast.com
  /paths/{path_id}/goal:
    get:
      summary: Goal API
      description: ''
      operationId: goal-api
      parameters:
      - name: user-id
        in: header
        description: Unique identifier for the unauthenticated user
        schema:
          type: string
      - name: anonymous-user-id
        in: header
        description: Unique authenticated identifier for the user
        schema:
          type: string
      - name: device_type
        in: query
        description: Accepted values are web, roku_os, ios, tv_os, android_os (additional values for custom devices may be specified). Defaults to web if not specified.
        schema:
          type: string
      - name: action_group_id
        in: query
        description: Value from Path object returned from Ping API
        schema:
          type: string
      - name: accept_type
        in: query
        description: (optional) Should be set to accept2 if the user clicks on the secondary button
        schema:
          type: string
      - name: path_id
        in: path
        description: ID from Path object returned from Ping API
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"success\": true,\n  \"configs\": { \"ping_frequency\": 10 }\n}"
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    default: true
                  configs:
                    type: object
                    properties:
                      ping_frequency:
                        type: integer
                        example: 10
                        default: 0
      deprecated: false
      security: []
      tags:
      - Paths
    servers:
    - url: https://conduit.redfast.com
  /paths/{path_id}/holdout:
    get:
      summary: Holdout API
      description: ''
      operationId: holdout-api
      parameters:
      - name: path_id
        in: path
        description: ID from Path object returned from Ping API
        schema:
          type: string
        required: true
      - name: device_type
        in: query
        description: Accepted values are web, roku_os, ios, tv_os, android_os (additional values for custom devices may be specified). Defaults to web if not specified.
        schema:
          type: string
      - name: action_group_id
        in: query
        description: Value from Path object returned from Ping API
        schema:
          type: string
      - name: user-id
        in: header
        description: Unique identifier for the unauthenticated user
        schema:
          type: string
      - name: anonymous-user-id
        in: header
        description: Unique authenticated identifier for the user
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"success\": true,\n  \"configs\": { \"ping_frequency\": 10 }\n}"
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    default: true
                  configs:
                    type: object
                    properties:
                      ping_frequency:
                        type: integer
                        example: 10
                        default: 0
      deprecated: false
      security: []
      tags:
      - Paths
    servers:
    - url: https://conduit.redfast.com
  /paths/goal_reset_all:
    get:
      summary: Reset API
      description: ''
      operationId: reset-api
      parameters:
      - name: id
        in: query
        description: App ID
        schema:
          type: string
      - name: device_type
        in: query
        description: Accepted values are web, roku_os, ios, tv_os, android_os (additional values for custom devices may be specified). Defaults to web if not specified.
        schema:
          type: string
      - name: client_reset_complete
        in: query
        description: Should default to `true`. Client should also clear any cached states of previous prompts.
        schema:
          type: string
          default: 'true'
      - name: user-id
        in: header
        description: Unique identifier for the unauthenticated user
        schema:
          type: string
      - name: anonymous-user-id
        in: header
        description: Unique authenticated identifier for the user
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"success\": true,\n  \"configs\": { \"ping_frequency\": 10 }\n}"
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    default: true
                  configs:
                    type: object
                    properties:
                      ping_frequency:
                        type: integer
                        example: 10
                        default: 0
      deprecated: false
      security: []
      tags:
      - Paths
    servers:
    - url: https://conduit.redfast.com
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: rf-app
x-refined-from:
- recurly-engage-custom-rendering-api.yaml
- recurly-engage-openapi.yml
x-readme:
  explorer-enabled: false

Recurly Paths API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources