Lynx

Lynx Tags API

The Tags API from Lynx — 2 operation(s) for tags.

GitHub OpenAPI

Operations 4

POST /tags Add Tags #
DELETE /tags Delete a Tag #
PATCH /tags Update Tags API #
GET /tags/list Get Tags #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lynx/refs/heads/main/openapi/lynx-tags-api-openapi.yml

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/lynx:lynx-tags-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

lynx-tags-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Tags API
  description: These API's are used to manage tags
  termsOfService: http://lynx-fh.com
  license:
    name: LynxFH
    url: http://lynx-fh.com
  version: '"1.0"'
servers:
- url: https://sandbox.lynx-fh.co
security:
- bearerAuth: []
tags:
- name: Tags
paths:
  /tags:
    post:
      tags:
      - Tags
      summary: Add Tags
      description: This API will add tags, which are optional meta data values, for a type of resource, such as member or transaction.
      operationId: addTag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTagResponseDoc'
        '400':
          description: 'Bad request.

            - GBL-137: A tag already exists with the same name in the database

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
    delete:
      tags:
      - Tags
      summary: Delete a Tag
      description: This API will allow you to delete a tag. Returns an empty data container when successful or exceptions when the request failed.
      operationId: deleteTag
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: resourceType
        in: query
        description: 'Indicates the type of resource for which the tags will be deleted. Possible values are: MEMBER, CLIENT_ORG, MEMBER_TRANSACTION'
        required: true
        schema:
          type: string
          enum:
          - MEMBER
          - CLIENT_ORG
          - MEMBER_TRANSACTION
          - MEMBER_DVH_SERVICE
        example: MEMBER
      - name: resourceId
        in: query
        description: Indicates the key based on the type of resource.  For a member, this will be client member ID.  For a transaction, this will be transaction reference ID.  For a client org, this will be client org name.
        required: true
        schema:
          type: string
        example: 3f50436491
      - name: tagName
        in: query
        description: Indicates the name of the tag to be deleted
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: 'Bad request.

            - GBL-174: Member is in Inactive state

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
    patch:
      tags:
      - Tags
      summary: Update Tags API
      description: Update Existing Tags on a Resource.
      operationId: patchTag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTagRequestDoc'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: 'Bad request.

            - GBL-137: A tag already exists with the same name in the database

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /tags/list:
    get:
      tags:
      - Tags
      summary: Get Tags
      description: Returns a list of tags for a type of resource, such as member or transaction.
      operationId: getTags
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: resourceType
        in: query
        description: 'Indicates the type of resource for which to retrieve the tags. Possible values are:  MEMBER, CLIENT_ORG, MEMBER_TRANSACTION'
        required: true
        schema:
          type: string
          enum:
          - MEMBER
          - CLIENT_ORG
          - MEMBER_TRANSACTION
          - MEMBER_DVH_SERVICE
        example: MEMBER
      - name: resourceId
        in: query
        description: Indicates the key based on the type of resource.  For a member, this will be client member ID.  For a transaction, this will be transaction reference ID.  For a client org, this will be client org name.
        required: true
        schema:
          type: string
        example: 3f50436491
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTagsResponseDoc'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
components:
  schemas:
    PatchTagRequestDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatchTagRequestDtoDoc'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
      required:
      - data
      - idempotency
    GetTagsResponse:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
        resourceType:
          type: string
          description: 'Indicates the type of resource for which to retrieve the tags. Possible values are:  MEMBER, CLIENT_ORG, MEMBER_TRANSACTION'
          example: MEMBER
        resourceId:
          type: string
          description: Indicates the key based on the type of resource.  For a member, this will be client member ID.  For a transaction, this will be transaction reference ID.  For a client org, this will be client org name.
          example: 3f50436491
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagDto'
      required:
      - resourceId
      - resourceType
    Idempotency:
      type: object
      properties:
        idempotencyKey:
          type: string
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
    TagRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TagRequestDto'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
      required:
      - data
      - idempotency
    TagRequestDto:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
        resourceType:
          type: string
          description: 'Indicates the type of resource for which the tags will be added. Possible values are: MEMBER, CLIENT_ORG, MEMBER_TRANSACTION'
          example: MEMBER
        resourceId:
          type: string
          description: Indicates the key based on the type of resource.  For a member, this will be client member ID.  For a transaction, this will be transaction reference ID.  For a client org, this will be client org name.
          example: 3f50436491
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagDto'
      required:
      - resourceId
      - resourceType
    TagDto:
      type: object
      properties:
        name:
          type: string
          description: Constant used to define the metadata within a key-value pair
        value:
          type: string
          description: Variable belonging to the metadata within a key-value pair
        type:
          type: string
          description: Additional client-defined qualifier that may be used to further classify the key-value pair
      required:
      - name
      - value
    TagDtoDoc:
      type: object
      properties:
        name:
          type: string
          description: Constant used to define the metadata within a key-value pair
          example: Chronic Condition
        value:
          type: string
          description: Variable belonging to the metadata within a key-value pair
          example: Diabetes
        type:
          type: string
          description: Additional client-defined qualifier that may be used to further classify the key-value pair
          example: Health Condition
      required:
      - name
    PostTagResponseDto:
      type: object
      properties:
        resourceType:
          type: string
          description: 'Indicates the type of resource for which the tags will be added. Possible values are: MEMBER, CLIENT_ORG, MEMBER_TRANSACTION'
          example: MEMBER
        resourceId:
          type: string
          description: Indicates the key based on the type of resource.  For a member, this will be client member ID.  For a transaction, this will be transaction reference ID.  For a client org, this will be client org name.
          example: 3f50436491
      required:
      - resourceId
      - resourceType
    PostTagResponseDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PostTagResponse'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    BaseResponse:
      type: object
      properties:
        data:
          type: object
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    ClientOrgDto:
      type: object
      properties:
        name:
          type: string
          description: The name of the client organization
          example: Health_Plan_ABC_Division
      required:
      - name
    GetTagsResponseDoc:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GetTagsResponse'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    ResponseException:
      type: object
      properties:
        errorCode:
          type: string
          description: The GBL error code that is populated when the exceptionSource is SYSTEM
        exceptionSource:
          type: string
          description: Characterizes the type of exception (JSON, SYSTEM, PARAMETER)
        exceptionMessage:
          type: string
          description: Additional information about the exception
    PostTagResponse:
      type: object
      properties:
        tag:
          $ref: '#/components/schemas/PostTagResponseDto'
    ExceptionBaseResponse:
      type: object
      properties:
        data:
          type: object
          description: 'null'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    PatchTagRequestDtoDoc:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
        resourceType:
          type: string
          description: 'Indicates the type of resource for which the tags will be added. Possible values are: MEMBER, CLIENT_ORG, MEMBER_TRANSACTION'
          example: MEMBER
        resourceId:
          type: string
          description: Indicates the key based on the type of resource.  For a member, this will be client member ID.  For a transaction, this will be transaction reference ID.  For a client org, this will be client org name.
          example: 3f50436491
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagDtoDoc'
      required:
      - resourceId
      - resourceType
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://docs.lynx-fh.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.lynx-fh.com/reference/addtag.md
  - https://docs.lynx-fh.com/reference/deletetag.md
  - https://docs.lynx-fh.com/reference/gettags.md
  - https://docs.lynx-fh.com/reference/patchtag.md
  merge:
    pages: 4
    deduped: 14
    conflicts_kept_first: 0