Support-Tickets auslesen

GET/customers/{customerNumber}/tickets/

API version

v1

Request method

GET

Operation ID

listSupportTickets

---

Listet Support-Tickets eines Kunden auf

Request

• customerNumbernumber

  required

  Die Kundennummer

Responses

Format

application/json

Description

Array von allen Support-Tickets

Schema documentation

• Array[
  • *object
    • uidinteger

      required
    • subjectstring

      required
    • messagestring

      required
    • createdAtstring (datetime)

      required
    • updatedAtstring (datetime)

      required
    • statusstring (one of: open, in-progress, feedback, information, answered, done)

      required
    • publicStatusstring (one of: open, in-progress, feedback, information, answered, done)

      required
    • authorobject

      required
      • namestring

        required
      • emailstring (email)

        required
      • telephonestring

        required
      • isMittwaldAuthorboolean

        required
    • accountobject
      • uidinteger

        required
      • namestring

        required
    • customerobject
      • customernumberinteger

        required
    • answersCountinteger

      required
    • filesarray of string (uuid)
      • Array[
        • *string (uuid)
        ]
  ]

Example

Content-Type: application/json

[
  {
    "uid": 123,
    "subject": "string",
    "message": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "status": "open",
    "publicStatus": "open",
    "author": {
      "name": "string",
      "email": "email@mittwald.example",
      "telephone": "string",
      "isMittwaldAuthor": true
    },
    "account": {
      "uid": 123,
      "name": "string"
    },
    "customer": {
      "customernumber": 123
    },
    "answersCount": 123,
    "files": [
      "f0f86186-0a5a-45b2-aa33-502777496347"
    ]
  }
]

JSON Schema

{
  "type": "array",
  "items": {
    "title": "Ticket",
    "required": [
      "answersCount",
      "author",
      "createdAt",
      "updatedAt",
      "message",
      "status",
      "publicStatus",
      "subject",
      "uid"
    ],
    "type": "object",
    "properties": {
      "uid": {
        "type": "integer"
      },
      "subject": {
        "type": "string"
      },
      "message": {
        "type": "string"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      },
      "status": {
        "title": "TicketStatus",
        "type": "string",
        "enum": [
          "open",
          "in-progress",
          "feedback",
          "information",
          "answered",
          "done"
        ]
      },
      "publicStatus": {
        "title": "TicketStatus",
        "type": "string",
        "enum": [
          "open",
          "in-progress",
          "feedback",
          "information",
          "answered",
          "done"
        ]
      },
      "author": {
        "required": [
          "email",
          "name",
          "telephone",
          "isMittwaldAuthor"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "telephone": {
            "type": "string"
          },
          "isMittwaldAuthor": {
            "type": "boolean"
          }
        }
      },
      "account": {
        "required": [
          "name",
          "uid"
        ],
        "type": "object",
        "properties": {
          "uid": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "customer": {
        "required": [
          "customernumber"
        ],
        "type": "object",
        "properties": {
          "customernumber": {
            "type": "integer"
          }
        }
      },
      "answersCount": {
        "type": "integer"
      },
      "files": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/customers/123/tickets?sortDirection=ASC&status=open&summaryOnly=true&limit=50