GET - List issues

List issues

Request

• Method: GET
• Endpoint: /issues
• Base URL: https://api.targpatrol.com/api/v1
• Operation ID: list-of-issues

Authorization

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Parameters

Name	In	Required	Schema	Description
limit	query	no	integer	include first N items of a resource collection
offset	query	no	number	exclude first N items of a resource collection
sort	query	no	string	sort items in a resource collection
q	query	no	string	This parameter is used for quick search across text fields.
priority	query	no	string	filter by priority
typeId	query	no	string	filter by type
status	query	no	string	filter by status
locationId	query	no	string	filter by location
createdById	query	no	string	filter by creator
assigneeId	query	no	string	filter by assignee

Responses

200 OK

Content-Type: application/json Schema: object

Schema

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PageResponse"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/IssueResponse"
          }
        }
      }
    }
  ]
}

Example: example

{
  "data": [
    {
      "id": "4adbc000-3095-42f3-bddd-d8a1da1ab2bd",
      "name": "Issue 1",
      "description": "Description 1",
      "typeId": "cfd47385-fc8e-4727-a1b5-383e1842af1b",
      "status": "OPEN",
      "priority": "MAJOR",
      "assigneeId": "46ed469f-38f9-44fc-b6d5-9ec34f1e03cd",
      "seen": false,
      "untilDate": "2023-12-31T00:00:00.000Z",
      "locationId": "663745ce-daf9-4c0b-8616-e12ed40e6a34",
      "pointId": "59623848-fb58-4e19-b686-724d42d53c95",
      "email": "manager@mail.com",
      "mediaIds": [
        "44100168-11b1-4396-b863-96872820ab5f"
      ],
      "lastModifiedAt": "2023-03-07T05:57:59.315Z",
      "createdBy": "d3b4eb7b-567b-4e09-8646-09b648bf3bd6"
    },
    {
      "id": "afb5c68c-6e29-4cb2-961a-be02b12b9cb3",
      "name": "Issue 2",
      "description": "Description 2",
      "typeId": "c56e0234-389c-4af9-bd58-10ab32842b88",
      "status": "RESOLVED",
      "priority": "CRITICAL",
      "assigneeId": "6865ba39-08f6-4d90-a34d-c3fc374ea60e",
      "seen": true,
      "untilDate": "2023-12-31T00:00:00.000Z",
      "locationId": "9406340a-38c4-47e2-b388-8d69c27b1c6e",
      "pointId": "247bde4f-befb-4729-be1f-27fcfca5ae55",
      "email": "manager@mail.com",
      "mediaIds": [
        "14f9f998-1352-43d7-854e-7a7cb91fde1b"
      ],
      "lastModifiedAt": "2023-03-07T05:57:59.315Z",
      "createdBy": "d3b4eb7b-567b-4e09-8646-09b648bf3bd6"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 2,
    "count": 1000,
    "sort": [
      {
        "property": "priority",
        "direction": "asc"
      }
    ]
  }
}

401 Unauthorized

500 Internal Server Error

Content-Type: application/json Schema: ErrorResponse

Schema

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}