Nirvana Tags API

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

GitHub OpenAPI

Operations 3

GET /v1/tags List tags with usage counts #
POST /v1/tags/batch Create tags (areas, contexts, people) #
PATCH /v1/tags/batch Change a tag's type or color #

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/nirvanahq-com:nirvanahq-com-tags-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

nirvanahq-com-tags-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nirvana Task Tags API
  version: 1.0.0-beta
  description: 'Nirvana Task API (Public Beta). Clean REST endpoints for integrations, automation, and AI agents (MCP servers, scripts, webhooks). Auth: `Bearer `. Legacy v0 endpoints are removed from this service; migrate integrations to /v1/* endpoints. During beta, backward compatibility is best-effort and minor response changes may occur before GA.'
servers:
- url: https://api.nirvanahq.com
security:
- bearerAuth: []
tags:
- name: Tags
paths:
  /v1/tags:
    get:
      operationId: v1GetTags
      summary: List tags with usage counts
      description: 'Returns all user tags and areas with task usage counts. Call before tagging tasks to see available options. With `profile=mcp`, returns the user''s vocabulary instead (`McpVocabularyResponse`): areas, contexts and people, each with a count of open tasks and the search query that lists them; it takes the search clock and scope parameters (`now`, `tz`, `weekstart`, `area`, `areamode`).'
      tags:
      - Tags
      parameters:
      - name: profile
        in: query
        description: '`mcp` for the vocabulary shape. Omit for the tag list.'
        schema:
          type: string
          enum:
          - mcp
      - $ref: '#/components/parameters/Now'
      - $ref: '#/components/parameters/Tz'
      - $ref: '#/components/parameters/Weekstart'
      - $ref: '#/components/parameters/Area'
      - $ref: '#/components/parameters/Areamode'
      responses:
        '200':
          description: Tag list, or the vocabulary with profile=mcp
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/McpVocabularyResponse'
                - type: object
                  required:
                  - ok
                  - tags
                  properties:
                    ok:
                      type: boolean
                    tags:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          type:
                            type: string
                            description: A contact tag (stored type 2) is a person.
                            enum:
                            - context
                            - area
                            - person
                          count:
                            type: integer
              example:
                ok: true
                tags:
                - name: work
                  type: context
                  count: 14
                - name: Home
                  type: area
                  count: 6
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/TooManyTasks'
  /v1/tags/batch:
    post:
      operationId: v1CreateTags
      summary: Create tags (areas, contexts, people)
      description: 'Creates each tag (type defaults to context). Asking again for an existing tag with the same type and color returns it with `created: false`; a different type or color is a 409 (use PATCH). A name that differs from an existing tag only in case is a 409. A deleted tag of that name is brought back. Names: up to 100 characters, no commas. All-or-nothing: a bad item fails the batch with its `index`.'
      tags:
      - Tags
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - tags
              properties:
                tags:
                  type: array
                  maxItems: 50
                  items:
                    $ref: '#/components/schemas/TagWrite'
      responses:
        '200':
          description: Every tag already existed as asked; nothing written
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagWriteResponse'
        '201':
          description: At least one tag created or brought back
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagWriteResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: The tag exists with another type or color, or in another case
    patch:
      operationId: v1UpdateTags
      summary: Change a tag's type or color
      description: Changes type and/or color. `name` matches exactly, or by case when only one tag matches that way. Renaming, merging and deleting are not supported yet (nirvana-hq#940).
      tags:
      - Tags
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - updates
              properties:
                updates:
                  type: array
                  maxItems: 50
                  items:
                    $ref: '#/components/schemas/TagWrite'
      responses:
        '200':
          description: The tags as they now are
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagWriteResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    TooManyTasks:
      description: 'Search, counts or vocabulary declined: the account has more rows to search than the server reads at once (20,000 by default). Retrying or narrowing the query does not help; the whole account is loaded before filtering.

        '
      content:
        application/json:
          schema:
            type: object
            properties:
              ok:
                type: boolean
              code:
                type: string
                enum:
                - too_many_tasks
              limit:
                type: integer
              error:
                type: string
          example:
            ok: false
            code: too_many_tasks
            limit: 20000
            error: This account has more than 20,000 tasks to search, more than search can read at once. This usually means repeating tasks or an automation have built up a large backlog. Contact Nirvana support at support@nirvanahq.com and we can help clean it up.
    NotFound:
      description: Task not found
      content:
        application/json:
          schema:
            type: object
            properties:
              ok:
                type: boolean
              error:
                type: string
          example:
            ok: false
            error: Task not found
    Unauthorized:
      description: Missing or invalid Bearer token
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          example:
            error: Unauthorized
    BadRequest:
      description: Invalid request (body or query parameters)
      content:
        application/json:
          schema:
            type: object
            properties:
              ok:
                type: boolean
              code:
                type: string
                description: Search-grammar reads only (search mode, profile=mcp). `invalid_request` for a bad parameter; `unknown_view`, `invalid_cursor` or `cursor_mismatch` for a bad view or cursor.
              error:
                type: string
          example:
            ok: false
            error: name is required
  schemas:
    TagWriteResponse:
      type: object
      properties:
        ok:
          type: boolean
        count:
          type: integer
        tags:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
                enum:
                - area
                - context
                - person
              color:
                type: string
              created:
                type: boolean
                description: POST only. false when the tag already existed as asked.
    McpVocabularyEntry:
      type: object
      properties:
        name:
          type: string
        count:
          type: integer
        query:
          type:
          - string
          - 'null'
          description: 'Null when the name contains a comma or a double quote, which no qualifier value can spell; filter such tasks another way.

            '
    TagWrite:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          maxLength: 100
        type:
          type: string
          enum:
          - area
          - context
          - person
        color:
          type: string
          enum:
          - red
          - orange
          - yellow
          - green
          - blue
          - purple
          - none
    McpVocabularyResponse:
      type: object
      required:
      - ok
      - grammar_version
      - areas
      - contexts
      - people
      description: 'GET /v1/tags?profile=mcp: the names a query can use, each with its count of open tasks and the query that lists them.

        '
      properties:
        ok:
          type: boolean
        grammar_version:
          type: integer
        timezone:
          type: string
        areas:
          type: array
          items:
            $ref: '#/components/schemas/McpVocabularyEntry'
        contexts:
          type: array
          items:
            $ref: '#/components/schemas/McpVocabularyEntry'
        people:
          type: array
          items:
            $ref: '#/components/schemas/McpVocabularyEntry'
  parameters:
    Area:
      name: area
      in: query
      description: Grammar reads only (search mode, profile=mcp). Area scope (all, none or an area name). Default all.
      schema:
        type: string
    Areamode:
      name: areamode
      in: query
      description: Grammar reads only (search mode, profile=mcp). Whether rows with no area stay in an area scope. Defaults to the user's stored area-filtering preference (exclusive when unset).
      schema:
        type: string
        enum:
        - inclusive
        - exclusive
    Tz:
      name: tz
      in: query
      description: Grammar reads only (search mode, profile=mcp). IANA zone or UTC offset for "today". Default the user's stored GMT offset.
      schema:
        type: string
    Now:
      name: now
      in: query
      description: Grammar reads only (search mode, profile=mcp). The evaluation instant (ISO 8601 with offset). Default the server clock.
      schema:
        type: string
    Weekstart:
      name: weekstart
      in: query
      description: Grammar reads only (search mode, profile=mcp). First day of the week for week ranges. Defaults to the user's stored week start (sun when unset).
      schema:
        type: string
        enum:
        - sun
        - mon
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer