Skip to main content

Reference

Platform reference & API catalog

Base URLhttps://app.jellyfish.co
AuthAuthorization: Token <token>

Allocations

11 endpoints
Allocations API endpoints
NamePathDescription
allocations_by_person/endpoints/export/v0/allocations/details/by_personAllocation data for the whole company, aggregated by person
allocations_by_team/endpoints/export/v0/allocations/details/by_teamAllocation data for the whole company, aggregated by team at specified hierarchy level
allocations_by_investment_category/endpoints/export/v0/allocations/details/investment_categoryAllocation data aggregated by investment category
allocations_by_investment_category_person/endpoints/export/v0/allocations/details/investment_category/by_personAllocation data aggregated by investment category and person
allocations_by_investment_category_team/endpoints/export/v0/allocations/details/investment_category/by_teamAllocation data aggregated by investment category and team
allocations_by_work_category/endpoints/export/v0/allocations/details/work_categoryAllocation data aggregated by deliverable within specified work category
allocations_by_work_category_person/endpoints/export/v0/allocations/details/work_category/by_personAllocation data aggregated by deliverable within work category and person
allocations_by_work_category_team/endpoints/export/v0/allocations/details/work_category/by_teamAllocation data aggregated by deliverable within work category and team
allocations_filter_fields/endpoints/export/v0/allocations/filter_fieldsAvailable fields and known values for filtering allocations
allocations_summary_by_investment_category/endpoints/export/v0/allocations/summary_filtered/by_investment_categoryTotal FTE amounts for investment categories (supports filtering)
allocations_summary_by_work_category/endpoints/export/v0/allocations/summary_filtered/by_work_categoryTotal FTE amounts for deliverables within a work category (supports filtering)

Delivery

4 endpoints
Delivery API endpoints
NamePathDescription
deliverable_details/endpoints/export/v0/delivery/deliverable_detailsData about a specific deliverable
deliverable_scope_and_effort_history/endpoints/export/v0/delivery/scope_and_effort_historyWeekly data about deliverable scope and total effort allocated per week
work_categories/endpoints/export/v0/delivery/work_categoriesList of all known work categories
work_category_contents/endpoints/export/v0/delivery/work_category_contentsData about deliverables in a specified work category

DevEx

1 endpoint
DevEx API endpoints
NamePathDescription
devex_insights_by_team/endpoints/export/v0/devex/insights/by_teamDevEx insights data by team

Metrics

5 endpoints
Metrics API endpoints
NamePathDescription
company_metrics/endpoints/export/v0/metrics/company_metricsMetrics data for the company during specified timeframe
person_metrics/endpoints/export/v0/metrics/person_metricsMetrics data for a specified person during specified timeframe
team_metrics/endpoints/export/v0/metrics/team_metricsMetrics data for a specified team during specified timeframe
team_sprint_summary/endpoints/export/v0/metrics/team_sprint_summaryIssue count and story point data for a team's sprints in specified timeframe
unlinked_pull_requests/endpoints/export/v0/metrics/unlinked_pull_requestsDetails of unlinked pull requests merged during specified timeframe

People

2 endpoints
People API endpoints
NamePathDescription
list_engineers/endpoints/export/v0/people/list_engineersList of all active allocatable people as of a specific date
search_people/endpoints/export/v0/people/searchSearch for people by name, email, or id

Teams

2 endpoints
Teams API endpoints
NamePathDescription
list_teams/endpoints/export/v0/teams/list_teamsAll teams at specified hierarchy level (optionally includes child teams)
search_teams/endpoints/export/v0/teams/searchSearch for teams by name or id