Zum Inhalt springen
Leadtime
Deutsch
Esc
navigateopen⌘Jpreview

Get pipeline data for date range

What is the Pipeline? The Pipeline is Leadtime’s weekly planning tool that provides a visual overview of all tasks scheduled for team members during a selected period. It shows team members vertically and calendar weeks horizontally, with each colored card representing a planned task. The pipeline is used in weekly planning meetings to schedule tasks according to importance and capacity, optimizing the use of available working time.

What data is returned: The response contains a complete pipeline view for the specified date range:

  • users: Object keyed by userId, each containing:
    • Employee information (employeeId, userId, name)
    • days: Array of day data including work day length, weekends, holidays, vacations, and sickness
    • items: Array of pipeline items (planned tasks) with task details, dates, and times
    • reality: Array of actual time logs (if enabled and user has permission)
  • ready: Boolean indicating if the week is marked as active/approved
  • year and week: ISO week number for the pipeline period

How it works:

  • Pipeline items are filtered to include tasks that start, end, or span across the specified date range
  • The order of tasks in the pipeline automatically transfers to each team member’s personal stack (Kanban board)
  • Dates are normalized to UTC and should be provided in ISO format (YYYY-MM-DD)
  • The pipeline supports two view modes: Overview (8-hour blocks) and Spacious (15-minute increments)

Permission-based Filtering:

  • usersFilter: "all" - Requires Pipeline.canViewAll permission to view all users
  • usersFilter: "me" - Requires Pipeline.canViewOwnTeams or Pipeline.canViewAll permission to view own data
  • usersFilter: "team:{teamId}" - Requires Pipeline.canViewOwnTeams permission and user must be a member of the specified team

Reality Data (Time Logs):

  • Set withReality: true to include actual booked working hours alongside planned tasks
  • Only includes time logs if user has Tasks.seeLoggedTime permission
  • If permission is missing, the reality array will be empty
  • This helps compare planned vs. actual work and improve future capacity estimates

Important - Understanding Time Format: In the response, items[].dateStart and items[].dateEnd contain both date and time components:

  • The date part (YYYY-MM-DD) represents the calendar day
  • The time part (HH) represents hours since the beginning of the work day, NOT since midnight
  • Times are stored in 15-minute increments (0, 15, 30, 45, 60, etc.) from work day start
  • Example: If work day starts at 09:00:
    • "2025-10-20T00:30:00Z" means 09 on Oct 20
    • "2025-10-20T05:30:00Z" means 14 on Oct 20
  • When reading these values, extract the time component relative to work day start, not midnight

Use cases:

  • Display weekly planning view in custom dashboards or integrations
  • Export pipeline data for reporting and analysis
  • Compare planned vs. actual work (with reality data)
  • Build custom planning tools that integrate with Leadtime’s pipeline system
GET/tasks/pipeline
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
dateStartstringrequired
Start date of the pipeline period in ISO format (YYYY-MM-DD). Pipeline items that start, end, or span across this date range will be included.
dateEndstringrequired
End date of the pipeline period in ISO format (YYYY-MM-DD). Pipeline items that start, end, or span across this date range will be included.
usersFilterstringrequired
Filter which users to include in the pipeline view. Options: "all" (requires Pipeline.canViewAll permission to view all users), "me" (requires Pipeline.canViewOwnTeams or Pipeline.canViewAll permission to view own data), or "team:{teamId}" (requires Pipeline.canViewOwnTeams permission and user must be a member of the specified team).
withRealityboolean
Include reality data (actual time logs) alongside planned tasks. When enabled, shows what team members actually worked on during the period. Only includes time logs if user has Tasks.seeLoggedTime permission. If permission is missing, the reality array will be empty. Useful for comparing planned vs. actual work.
default: false
Responses
200Pipeline data successfully retrieved. Returns an object with users keyed by userId, ready status, year, and week.
readybooleanrequired
Whether the pipeline week is marked as active/ready. When true, the planned tasks are visible in employee stacks. When false, the week is still in draft/planning mode.
usersobjectrequired
Object containing pipeline data for each user, keyed by userId. Each entry contains employee information, days array (work day data), items array (planned tasks), and reality array (time logs if enabled).
weeknumberrequired
ISO week number of the pipeline period start date
yearnumberrequired
Year of the pipeline period start date (ISO week year)
400Invalid date format or filter value
401Unauthorized - Invalid or missing authentication token
403Missing required permissions
Request
curl -X GET "https://leadtime.app/api/public/tasks/pipeline?dateStart=2025-10-20&dateEnd=2025-11-02&usersFilter=me" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "ready": true,
  "users": {
    "user-id-1": {
      "days": [],
      "employeeId": "employee-id-1",
      "items": [],
      "name": "John Doe",
      "reality": [],
      "userId": "user-id-1"
    }
  },
  "week": 43,
  "year": 2025
}