NudgeLink Engagers API

The engagers API from NudgeLink — 4 operation(s) for engagers.

GitHub OpenAPI

Operations 5

GET /api/v1/engagers Get Engagers #
PUT /api/v1/engagers/settings Put Settings #
POST /api/v1/engagers/watches Add Watch #
PATCH /api/v1/engagers/watches/{watch_id} Patch Watch #
DELETE /api/v1/engagers/watches/{watch_id} Delete Watch #

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/nudgelink-co:nudgelink-co-engagers-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

nudgelink-co-engagers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Engagers API
  version: 0.1.0
tags:
- name: engagers
paths:
  /api/v1/engagers:
    get:
      tags:
      - engagers
      summary: Get Engagers
      operationId: get_engagers_api_v1_engagers_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngagersOut'
      security:
      - HTTPBearer: []
  /api/v1/engagers/settings:
    put:
      tags:
      - engagers
      summary: Put Settings
      operationId: put_settings_api_v1_engagers_settings_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngagersOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/engagers/watches:
    post:
      tags:
      - engagers
      summary: Add Watch
      operationId: add_watch_api_v1_engagers_watches_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatchIn'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngagersOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/engagers/watches/{watch_id}:
    patch:
      tags:
      - engagers
      summary: Patch Watch
      operationId: patch_watch_api_v1_engagers_watches__watch_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: watch_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Watch Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatchPatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngagersOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - engagers
      summary: Delete Watch
      operationId: delete_watch_api_v1_engagers_watches__watch_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: watch_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Watch Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngagersOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WatchIn:
      properties:
        url:
          type: string
          maxLength: 512
          minLength: 10
          title: Url
        label:
          type: string
          maxLength: 255
          title: Label
          default: ''
        campaign_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Campaign Id
      type: object
      required:
      - url
      title: WatchIn
    WatchOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        kind:
          type: string
          title: Kind
        target:
          type: string
          title: Target
        label:
          type: string
          title: Label
        source:
          type: string
          title: Source
        active:
          type: boolean
          title: Active
        campaign_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Campaign Id
        last_pulled_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Pulled At
      type: object
      required:
      - id
      - kind
      - target
      - label
      - source
      - active
      title: WatchOut
    WatchPatch:
      properties:
        active:
          type: boolean
          title: Active
      type: object
      required:
      - active
      title: WatchPatch
    EngagersOut:
      properties:
        enabled:
          type: boolean
          title: Enabled
        weekly_cap:
          type: integer
          title: Weekly Cap
        last_run_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Run At
        watches:
          items:
            $ref: '#/components/schemas/WatchOut'
          type: array
          title: Watches
      type: object
      required:
      - enabled
      - weekly_cap
      - watches
      title: EngagersOut
    SettingsIn:
      properties:
        enabled:
          type: boolean
          title: Enabled
        weekly_cap:
          type: integer
          maximum: 50.0
          minimum: 1.0
          title: Weekly Cap
      type: object
      required:
      - enabled
      - weekly_cap
      title: SettingsIn
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer