NudgeLink Admin Managed API

The admin-managed API from NudgeLink — 5 operation(s) for admin-managed.

GitHub OpenAPI

Operations 5

GET /api/v1/admin/managed List Managed #
PATCH /api/v1/admin/managed/{client_id} Patch Managed #
GET /api/v1/admin/managed/{client_id}/report Report Json #
GET /api/v1/admin/managed/{client_id}/report.html Report Html #
POST /api/v1/admin/managed/{client_id}/report/email Email Report #

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-admin-managed-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-admin-managed-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Admin Managed API
  version: 0.1.0
tags:
- name: admin-managed
paths:
  /api/v1/admin/managed:
    get:
      tags:
      - admin-managed
      summary: List Managed
      operationId: list_managed_api_v1_admin_managed_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ManagedRow'
                type: array
                title: Response List Managed Api V1 Admin Managed Get
      security:
      - HTTPBearer: []
  /api/v1/admin/managed/{client_id}:
    patch:
      tags:
      - admin-managed
      summary: Patch Managed
      operationId: patch_managed_api_v1_admin_managed__client_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Client Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagedPatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedRow'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/managed/{client_id}/report:
    get:
      tags:
      - admin-managed
      summary: Report Json
      operationId: report_json_api_v1_admin_managed__client_id__report_get
      security:
      - HTTPBearer: []
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Client Id
      - name: week
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Week
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Report Json Api V1 Admin Managed  Client Id  Report Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/managed/{client_id}/report.html:
    get:
      tags:
      - admin-managed
      summary: Report Html
      operationId: report_html_api_v1_admin_managed__client_id__report_html_get
      security:
      - HTTPBearer: []
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Client Id
      - name: week
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Week
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/managed/{client_id}/report/email:
    post:
      tags:
      - admin-managed
      summary: Email Report
      operationId: email_report_api_v1_admin_managed__client_id__report_email_post
      security:
      - HTTPBearer: []
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Client Id
      - name: week
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Week
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Email Report Api V1 Admin Managed  Client Id  Report Email Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GuaranteeOut:
      properties:
        state:
          type: string
          title: State
        start:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start
        ends:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Ends
        day:
          type: integer
          title: Day
        positives:
          type: integer
          title: Positives
        target:
          type: integer
          title: Target
        behind:
          type: boolean
          title: Behind
      type: object
      required:
      - state
      - start
      - ends
      - day
      - positives
      - target
      - behind
      title: GuaranteeOut
    ManagedRow:
      properties:
        client_id:
          type: string
          format: uuid
          title: Client Id
        company_name:
          type: string
          title: Company Name
        tier:
          anyOf:
          - type: string
          - type: 'null'
          title: Tier
        since:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Since
        pause_days:
          type: integer
          title: Pause Days
        guarantee_start_override:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Guarantee Start Override
        guarantee:
          $ref: '#/components/schemas/GuaranteeOut'
      type: object
      required:
      - client_id
      - company_name
      - tier
      - since
      - pause_days
      - guarantee_start_override
      - guarantee
      title: ManagedRow
    ManagedPatch:
      properties:
        tier:
          anyOf:
          - type: string
            enum:
            - core
            - plus
            - founding
          - type: 'null'
          title: Tier
        since:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Since
        guarantee_start:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Guarantee Start
        pause_days:
          anyOf:
          - type: integer
            maximum: 60.0
            minimum: 0.0
          - type: 'null'
          title: Pause Days
        clear_guarantee_start:
          type: boolean
          title: Clear Guarantee Start
          default: false
        clear:
          type: boolean
          title: Clear
          default: false
      type: object
      title: ManagedPatch
    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