Get issues by list id

Gets the list of issues. The maximum number of issues is 100.

get
Query parameters
idsstring[]Required

The list of the id to apply.

Header parameters
Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL
Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY
Responses
200
The request was successful.
application/json
get
GET /api/v1/issues/by-list HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*
{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "assigneeUserId": "USER_ASSIGN_ID",
      "parentId": "PARENT_ID",
      "name": "NAME",
      "description": "DESCRIPTION",
      "refType": 1,
      "refObject": "REF_OBJECT",
      "refId": 1,
      "content": "CONTENT",
      "issueCc": "ISSUE_CC",
      "issueCategoryCode": "ISSUE_CATEGORY_CODE",
      "issueCategoryName": "ISSUE_CATEGORY_NAME",
      "priority": "High",
      "tags": "#User",
      "status": "Active",
      "medias": [
        "https://example.com/media/issue.png"
      ],
      "children": [],
      "childrenCount": 1,
      "reactions": [
        {
          "type": "Like",
          "userId": "USER_ID",
          "id": "ID"
        }
      ],
      "user": {
        "id": "Plamxinzg18snza",
        "code": "EXAMPLE",
        "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
        "packageId": "1Plamxinzg18snza",
        "packageCode": "PACKAGE",
        "emailAddress": "[email protected]",
        "nickName": "example",
        "roles": [
          "admin",
          "support"
        ]
      }
    }
  ],
  "errors": []
}

Last updated

Was this helpful?