Sign in
issue

Get all issues

Returns a list of issues in JSON format.

get/issue

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/issue
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Query parameters

takenumber nullable
Example:20
skipnumber nullable
sort'added' | 'modified'
filter'all' | 'open' | 'resolved'
requestedBynumber nullable
Example:1

Response

Issues returned

Example response

{
  "pageInfo": {
    "page": 1,
    "pages": 10,
    "results": 100
  },
  "results": [
    {
      "id": 1,
      "issueType": 1,
      "media": {
        "requests": [
          {
            "id": 123,
            "createdAt": "2020-09-12T10:00:27.000Z",
            "updatedAt": "2020-09-12T10:00:27.000Z",
            "requestedBy": {
              "id": 1,
              "email": "hey@itsme.com",
              "userType": 1,
              "createdAt": "2020-09-02T05:02:23.000Z",
              "updatedAt": "2020-09-02T05:02:23.000Z",
              "requestCount": 5
            },
            "modifiedBy": {
              "id": 1,
              "email": "hey@itsme.com",
              "userType": 1,
              "createdAt": "2020-09-02T05:02:23.000Z",
              "updatedAt": "2020-09-02T05:02:23.000Z",
              "requestCount": 5
            }
          }
        ],
        "createdAt": "2020-09-12T10:00:27.000Z",
        "updatedAt": "2020-09-12T10:00:27.000Z"
      },
      "createdBy": {
        "id": 1,
        "email": "hey@itsme.com",
        "userType": 1,
        "createdAt": "2020-09-02T05:02:23.000Z",
        "updatedAt": "2020-09-02T05:02:23.000Z",
        "requestCount": 5
      },
      "modifiedBy": {
        "id": 1,
        "email": "hey@itsme.com",
        "userType": 1,
        "createdAt": "2020-09-02T05:02:23.000Z",
        "updatedAt": "2020-09-02T05:02:23.000Z",
        "requestCount": 5
      },
      "comments": [
        {
          "id": 1,
          "user": {
            "id": 1,
            "email": "hey@itsme.com",
            "userType": 1,
            "createdAt": "2020-09-02T05:02:23.000Z",
            "updatedAt": "2020-09-02T05:02:23.000Z",
            "requestCount": 5
          },
          "message": "A comment"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 21 revisions of this API.