Skip to content

Issue Tracker - Subscribers

GET    /api/issue-tracker-tickets/{ticket_id}/subscribers
POST   /api/issue-tracker-tickets/{ticket_id}/subscribers
DELETE /api/issue-tracker-tickets/{ticket_id}/subscribers

Authentication required.

Subscribers receive notifications when a ticket is updated or commented on.


GET - List Subscribers

GET /api/issue-tracker-tickets/TKT-001/subscribers HTTP/1.1

Response

{
  "data": {
    "subscribers": [
      "jane.doe@acme.com",
      "ops.team@acme.com"
    ]
  }
}

POST - Add Subscribers

POST /api/issue-tracker-tickets/TKT-001/subscribers HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "emails": ["ops.team@acme.com", "mgmt@acme.com"]
}
Field Type Required Description
emails array of strings Yes Email addresses to subscribe

Response

{
  "message": "Subscribers added.",
  "added": 2
}

DELETE - Remove Subscribers

DELETE /api/issue-tracker-tickets/TKT-001/subscribers HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "emails": ["mgmt@acme.com"]
}

Response

{
  "message": "Subscribers removed.",
  "removed": 1
}

Code Example

csrf = session.cookies.get("csrf_access_token")
ticket_id = "TKT-001"

# Add subscribers
session.post(
    f"https://acme.knosc.com/api/issue-tracker-tickets/{ticket_id}/subscribers",
    headers={"X-XSRF-TOKEN": csrf},
    json={"emails": ["ops.team@acme.com"]}
)

# List subscribers
r = session.get(
    f"https://acme.knosc.com/api/issue-tracker-tickets/{ticket_id}/subscribers"
)
print(r.json()["data"]["subscribers"])