Mist MSPs Tickets API

Support tickets are a means for users to seek assistance and resolve issues they encounter with a product or service. They allow users to communicate their problems or questions to the Juniper Mist support team, who can then provide guidance, troubleshooting, or solutions. Support tickets typically include information such as the type of issue, relevant details, and any necessary attachments. Support Tickets API Calls at the MSP level can be used to retrieve the tickets for each Organization attached to the MSP account.

OpenAPI Specification

mist-msps-tickets-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  contact:
    email: tmunzer@juniper.net
    name: Thomas Munzer
  description: '> Version: **2606.1.1**

    >

    > Date: **July 10, 2026**

    <div class="notification"> NOTE:<br>Some important API changes will be introduced. Please make sure to read the <a href="https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/important-api-changes">announcements</a> </div>


    ---

    ## Additional Documentation

    * [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)

    * [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html)

    * [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/)


    ## Helpful Resources

    * [API Sandbox and Exercises](https://api-class.mist.com/)

    * [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)

    * [Python Script Examples](https://github.com/tmunzer/mist_library)

    * [API Demo Apps](https://apps.mist-lab.fr/)

    * [Juniper Blog](https://blogs.juniper.net/)


    ## Mist Web Browser Extension:

    * Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh)

    * Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/)


    ---'
  license:
    name: MIT
    url: https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE
  title: Mist Admins MSPs Tickets API
  version: 2606.1.1
  x-logo:
    altText: Juniper-MistAI
    backgroundColor: '#FFFFFF'
    url: https://www.mist.com/wp-content/uploads/logo.png
servers:
- description: Mist Global 01
  url: https://api.mist.com
- description: Mist Global 02
  url: https://api.gc1.mist.com
- description: Mist Global 03
  url: https://api.ac2.mist.com
- description: Mist Global 04
  url: https://api.gc2.mist.com
- description: Mist Global 05
  url: https://api.gc4.mist.com
- description: Mist EMEA 01
  url: https://api.eu.mist.com
- description: Mist EMEA 02
  url: https://api.gc3.mist.com
- description: Mist EMEA 03
  url: https://api.ac6.mist.com
- description: Mist EMEA 04
  url: https://api.gc6.mist.com
- description: Mist APAC 01
  url: https://api.ac5.mist.com
- description: Mist APAC 02
  url: https://api.gc5.mist.com
- description: Mist APAC 03
  url: https://api.gc7.mist.com
security:
- apiToken: []
- csrfToken: []
tags:
- description: 'Support tickets are a means for users to seek assistance and resolve issues they encounter with a product or service.

    They allow users to communicate their problems or questions to the Juniper Mist support team, who can then provide guidance, troubleshooting, or solutions.

    Support tickets typically include information such as the type of issue, relevant details, and any necessary attachments.


    Support Tickets API Calls at the MSP level can be used to retrieve the tickets for each Organization attached to the MSP account.'
  name: MSPs Tickets
paths:
  /api/v1/msps/{msp_id}/tickets:
    parameters:
    - $ref: '#/components/parameters/msp_id'
    get:
      description: List support tickets associated with this MSP for the requested time range.
      operationId: listMspTickets
      parameters:
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/duration'
      responses:
        '200':
          $ref: '#/components/responses/TicketsArray'
        '400':
          $ref: '#/components/responses/HTTP400'
        '401':
          $ref: '#/components/responses/HTTP401'
        '403':
          $ref: '#/components/responses/HTTP403'
        '404':
          $ref: '#/components/responses/HTTP404'
        '429':
          $ref: '#/components/responses/HTTP429'
      summary: listMspTickets
      tags:
      - MSPs Tickets
  /api/v1/msps/{msp_id}/tickets/count:
    parameters:
    - $ref: '#/components/parameters/msp_id'
    get:
      description: Return distinct counts of MSP support tickets grouped by the requested field, such as organization, status, or ticket type.
      operationId: countMspTickets
      parameters:
      - description: 'Field used to group this count response. enum: `org_id`, `status`, `type`'
        in: query
        name: distinct
        schema:
          $ref: '#/components/schemas/msp_tickets_count_distinct'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          $ref: '#/components/responses/Count'
        '400':
          $ref: '#/components/responses/HTTP400'
        '401':
          $ref: '#/components/responses/HTTP401'
        '403':
          $ref: '#/components/responses/HTTP403'
        '404':
          $ref: '#/components/responses/HTTP404'
        '429':
          $ref: '#/components/responses/HTTP429'
      summary: countMspTickets
      tags:
      - MSPs Tickets
components:
  schemas:
    ticket_comments_attachments:
      description: List of attachment metadata objects for a ticket comment
      items:
        $ref: '#/components/schemas/ticket_comments_attachment'
      readOnly: true
      type: array
    tickets:
      description: Support ticket records returned by a ticket list response
      items:
        $ref: '#/components/schemas/ticket'
      type: array
    id:
      description: Unique ID of the object instance in the Mist Organization
      examples:
      - 53f10664-3ce8-4c27-b382-0ef66432349f
      format: uuid
      readOnly: true
      type: string
    ticket_comment:
      description: Comment on a support ticket
      properties:
        attachment_ids:
          $ref: '#/components/schemas/ticket_comments_attachment_ids'
          description: Identifiers of attachments linked to this ticket comment
        attachments:
          $ref: '#/components/schemas/ticket_comments_attachments'
          description: Attachment metadata returned with this ticket comment
        author:
          description: User who wrote this ticket comment
          readOnly: true
          type: string
        comment:
          description: Text body of this ticket comment
          type: string
        created_at:
          description: Time when this ticket comment was created, in epoch seconds
          readOnly: true
          type: integer
      required:
      - author
      - comment
      - created_at
      type: object
    response_http429:
      additionalProperties: false
      description: Standard HTTP 429 rate limit error response
      properties:
        detail:
          description: Human-readable explanation of the rate limit error
          examples:
          - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          type: string
      type: object
    response_http401:
      additionalProperties: false
      description: Standard HTTP 401 authentication error response
      properties:
        detail:
          description: Human-readable explanation of the authentication error
          examples:
          - Authentication credentials were not provided.
          type: string
      type: object
    ticket:
      description: Support ticket record with status, comments, and metadata
      properties:
        case_number:
          description: Support case number associated with this ticket
          readOnly: true
          type: string
        comments:
          $ref: '#/components/schemas/ticket_comments'
          description: Discussion comments recorded on this support ticket
        created_at:
          description: Time when this support ticket was created, in epoch seconds
          readOnly: true
          type: integer
        id:
          $ref: '#/components/schemas/id'
          description: Unique identifier for this support ticket
        requester:
          description: User who opened or requested this support ticket
          readOnly: true
          type: string
        requester_email:
          description: Email of the requester
          format: email
          type: string
        status:
          $ref: '#/components/schemas/ticket_status'
          description: Current lifecycle status of this support ticket
        subject:
          description: Short summary of the support request
          type: string
        type:
          description: Question (default) / bug / critical
          type: string
        updated_at:
          description: Time when this support ticket was last updated, in epoch seconds
          readOnly: true
          type: integer
      required:
      - subject
      - type
      type: object
    response_http403:
      additionalProperties: false
      description: Standard HTTP 403 permission error response
      properties:
        detail:
          description: Human-readable explanation of the permission error
          examples:
          - You do not have permission to perform this action.
          type: string
      type: object
    count_results:
      description: List of count result rows
      items:
        $ref: '#/components/schemas/count_result'
      type: array
      uniqueItems: true
    response_http400:
      additionalProperties: false
      description: Standard HTTP 400 bad request error response
      properties:
        detail:
          description: Human-readable explanation of the bad request error
          examples:
          - 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
          type: string
      type: object
    ticket_comments_attachment_ids:
      description: List of ticket comment attachment identifiers
      examples:
      - - 00000000-0000-0000-0000-15231a659c78
      items:
        $ref: '#/components/schemas/ticket_comments_attachment_id'
      readOnly: true
      type: array
    msp_tickets_count_distinct:
      default: status
      description: 'enum: `org_id`, `status`, `type`'
      enum:
      - org_id
      - status
      - type
      type: string
    count_result:
      additionalProperties:
        type: string
      description: Count result row with the matching distinct field values
      properties:
        count:
          description: Number of matching items for the distinct value or values in this result
          type: integer
      required:
      - count
      type: object
    response_count:
      additionalProperties: false
      description: Distinct count response for time-bounded search results
      properties:
        distinct:
          description: Field used to group the count results
          type: string
        end:
          description: Search window end timestamp for the count request, in epoch seconds
          type: integer
        limit:
          description: Maximum number of distinct count results requested
          type: integer
        results:
          $ref: '#/components/schemas/count_results'
          description: Count results grouped by the distinct field
        start:
          description: Search window start timestamp for the count request, in epoch seconds
          type: integer
        total:
          description: Number of distinct result buckets returned
          type: integer
      required:
      - distinct
      - end
      - limit
      - results
      - start
      - total
      type: object
    ticket_comments:
      description: List of comments on a support ticket
      items:
        $ref: '#/components/schemas/ticket_comment'
      type: array
    ticket_comments_attachment_id:
      description: Unique identifier for a ticket comment attachment
      examples:
      - 00000000-0000-0000-0000-15231a659c13
      format: uuid
      readOnly: true
      type: string
    ticket_comments_attachment:
      additionalProperties: false
      description: Metadata for an attachment on a ticket comment
      properties:
        content_type:
          description: MIME type of the ticket comment attachment
          examples:
          - image/png
          type: string
        content_url:
          description: Download URL for the ticket comment attachment
          examples:
          - https://api.mist.com/api/v1/forward/download?jwt=...
          format: url
          type: string
        created_at:
          description: Time when this ticket comment attachment was created, in epoch seconds
          examples:
          - 1453908369
          type: integer
        file_name:
          description: Original file name of the ticket comment attachment
          examples:
          - crash.png
          type: string
        id:
          $ref: '#/components/schemas/id'
          description: Unique identifier for this ticket comment attachment
        size_in_bytes:
          description: Attachment file size, in bytes
          examples:
          - 1943
          type: integer
      type: object
    response_http404:
      additionalProperties: false
      description: Standard HTTP 404 not found error response
      properties:
        id:
          description: Missing resource identifier, when the API includes one
          type: string
      type: object
    ticket_status:
      description: 'Ticket status. enum: `closed`, `open`, `pending`, `solved`. `open` means Mist is working on it, `pending` means requester attention is needed, `solved` means Mist considers it resolved but it can still be updated or rated, and `closed` means it is archived'
      enum:
      - closed
      - open
      - pending
      - solved
      type: string
  responses:
    HTTP429:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP429Example'
          schema:
            $ref: '#/components/schemas/response_http429'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP429Example'
          schema:
            $ref: '#/components/schemas/response_http429'
      description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
    Count:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/CountExample'
          schema:
            $ref: '#/components/schemas/response_count'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/CountExample'
          schema:
            $ref: '#/components/schemas/response_count'
      description: Result of Count
    HTTP400:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP400Example'
          schema:
            $ref: '#/components/schemas/response_http400'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP400Example'
          schema:
            $ref: '#/components/schemas/response_http400'
      description: Bad Syntax
    HTTP403:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP403Example'
          schema:
            $ref: '#/components/schemas/response_http403'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP403Example'
          schema:
            $ref: '#/components/schemas/response_http403'
      description: Permission Denied
    TicketsArray:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/TicketsArrayExample'
          schema:
            $ref: '#/components/schemas/tickets'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/TicketsArrayExample'
          schema:
            $ref: '#/components/schemas/tickets'
      description: OK
    HTTP404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/response_http404'
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/response_http404'
      description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
    HTTP401:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP401Example'
          schema:
            $ref: '#/components/schemas/response_http401'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP401Example'
          schema:
            $ref: '#/components/schemas/response_http401'
      description: Unauthorized
  parameters:
    msp_id:
      in: path
      name: msp_id
      required: true
      schema:
        examples:
        - 000000ab-00ab-00ab-00ab-0000000000ab
        format: uuid
        type: string
    start:
      description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
      in: query
      name: start
      schema:
        type: string
    duration:
      description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
      in: query
      name: duration
      schema:
        default: 1d
        examples:
        - 10m
        type: string
    limit:
      description: Maximum number of results to return per page
      in: query
      name: limit
      schema:
        default: 100
        minimum: 0
        type: integer
    end:
      description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
      in: query
      name: end
      schema:
        type: string
  examples:
    CountExample:
      value:
        distinct: string
        end: 0
        limit: 0
        results:
        - count: 0
          property: string
        start: 0
        total: 0
    HTTP403Example:
      value:
        detail: You do not have permission to perform this action.
    HTTP400Example:
      value:
        detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
    HTTP429Example:
      value:
        detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
    TicketsArrayExample:
      value:
      - comments:
        - attachments:
          - content_type: string
            content_url: string
          author: string
          comment: string
          created_at: 0
        created_at: 0
        id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        requester: string
        status: open
        subject: string
        type: string
        updated_at: 0
    HTTP401Example:
      value:
        detail: Authentication credentials were not provided.
  securitySchemes:
    apiToken:
      description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n  `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed."
      in: header
      name: Authorization
      type: apiKey
    csrfToken:
      description: 'Session-based authentication for browser or login/password flows. After a successful [Login](/#operations/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session.


        **Format**:

        ```

        X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx

        ```


        For automation, API Token authentication is preferred.'
      in: header
      name: X-CSRFToken
      type: apiKey