NudgeLink Exclusions API

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

GitHub OpenAPI

Operations 4

GET /api/v1/exclusions List Exclusions #
POST /api/v1/exclusions/import Import Exclusions #
DELETE /api/v1/exclusions/people Remove Listed People #
DELETE /api/v1/exclusions/{exclusion_id} Delete Exclusion #

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-exclusions-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-exclusions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Exclusions API
  version: 0.1.0
tags:
- name: exclusions
paths:
  /api/v1/exclusions:
    get:
      tags:
      - exclusions
      summary: List Exclusions
      operationId: list_exclusions_api_v1_exclusions_get
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 200
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExclusionList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/exclusions/import:
    post:
      tags:
      - exclusions
      summary: Import Exclusions
      operationId: import_exclusions_api_v1_exclusions_import_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/exclusions/people:
    delete:
      tags:
      - exclusions
      summary: Remove Listed People
      description: 'Remove every PERSON the client listed (they are hashes, so they cannot be removed one by

        one). A person''s own objection (unsubscribe, opt-out, bounce, "no") is never touched.'
      operationId: remove_listed_people_api_v1_exclusions_people_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeopleRemoved'
      security:
      - HTTPBearer: []
  /api/v1/exclusions/{exclusion_id}:
    delete:
      tags:
      - exclusions
      summary: Delete Exclusion
      operationId: delete_exclusion_api_v1_exclusions__exclusion_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: exclusion_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Exclusion Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ImportOut:
      properties:
        companies:
          type: integer
          title: Companies
        people:
          type: integer
          title: People
        skipped:
          type: integer
          title: Skipped
      type: object
      required:
      - companies
      - people
      - skipped
      title: ImportOut
    ImportBody:
      properties:
        text:
          type: string
          maxLength: 1000000
          minLength: 1
          title: Text
        reason:
          type: string
          enum:
          - customer
          - partner
          - competitor
          - manual
          title: Reason
          default: customer
      type: object
      required:
      - text
      title: ImportBody
    PeopleRemoved:
      properties:
        removed:
          type: integer
          title: Removed
      type: object
      required:
      - removed
      title: PeopleRemoved
    ExclusionList:
      properties:
        total:
          type: integer
          title: Total
        people_total:
          type: integer
          title: People Total
        items:
          items:
            $ref: '#/components/schemas/ExclusionOut'
          type: array
          title: Items
      type: object
      required:
      - total
      - people_total
      - items
      title: ExclusionList
    ExclusionOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        kind:
          type: string
          title: Kind
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
        reason:
          type: string
          title: Reason
        source:
          type: string
          title: Source
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - kind
      - value
      - label
      - reason
      - source
      - created_at
      title: ExclusionOut
    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