Work Items

Get work item by ID

get

Fetch a work item from the specified platform

Path parameters

platformstring · enumRequired

Platform to fetch from

Possible values:

idstringRequired

Work item ID (e.g., DP-6 for Jira)

Example: DP-6

Responses

200

Work item retrieved successfully

application/json

ResponseanyExample: {"id":"10042","key":"DP-6","title":"Implement user authentication","description":"Add OAuth 2.0 authentication flow","type":"story","status":"In Progress","priority":"High","assignee":{"id":"user123","name":"John Doe","email":"[email protected]","avatarUrl":"https://example.com/avatar.png"},"reporter":{"id":"user456","name":"Jane Smith","email":"[email protected]"},"labels":["backend","security"],"createdAt":"2025-01-10T08:00:00.000Z","updatedAt":"2025-01-11T14:30:00.000Z","platform":"jira","url":"https://flxbl-demo.atlassian.net/browse/DP-6","parent":{"id":"10040","key":"DP-1","title":"Authentication Epic"},"customFields":{"projectKey":"DP","projectName":"Demo Project","issueTypeId":"10001","statusId":"3"}}

404

Work item not found

get

/sfp/api/work-items/{platform}/{id}

HTTPcURLJavaScriptPython

GET /sfp/api/work-items/{platform}/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "10042",
  "key": "DP-6",
  "title": "Implement user authentication",
  "description": "Add OAuth 2.0 authentication flow",
  "type": "story",
  "status": "In Progress",
  "priority": "High",
  "assignee": {
    "id": "user123",
    "name": "John Doe",
    "email": "[email protected]",
    "avatarUrl": "https://example.com/avatar.png"
  },
  "reporter": {
    "id": "user456",
    "name": "Jane Smith",
    "email": "[email protected]"
  },
  "labels": [
    "backend",
    "security"
  ],
  "createdAt": "2025-01-10T08:00:00.000Z",
  "updatedAt": "2025-01-11T14:30:00.000Z",
  "platform": "jira",
  "url": "https://flxbl-demo.atlassian.net/browse/DP-6",
  "parent": {
    "id": "10040",
    "key": "DP-1",
    "title": "Authentication Epic"
  },
  "customFields": {
    "projectKey": "DP",
    "projectName": "Demo Project",
    "issueTypeId": "10001",
    "statusId": "3"
  }
}

List work items

get

List work items from the specified platform with optional filters

Path parameters

platformstring · enumRequired

Platform to fetch from

Possible values:

Query parameters

projectstringOptional

Project key/identifier

statusstringOptional

Work item status

assigneestringOptional

Filter by assignee

typestringOptional

Filter by work item type

maxResultsnumberOptional

Maximum number of results (1-100)

Example: 50

Responses

200

Work items retrieved successfully

No content

get

/sfp/api/work-items/{platform}

HTTPcURLJavaScriptPython

GET /sfp/api/work-items/{platform} HTTP/1.1
Host: 
Accept: */*

200

Work items retrieved successfully

No content