{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.orgonaut.co" } ], "info": { "name": "Orgonaut API Documentation", "_postman_id": "a91a9dad-b626-49e6-a2dc-8eb409506e56", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "AI Tooling Usage", "description": "", "item": [ { "name": "AI Tooling \u2014 List daily usage records", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ai-tooling\/usage", "query": [ { "key": "actor_id", "value": "42", "description": "Filter by actor ID. Only returns records matched to this actor.", "disabled": false }, { "key": "provider", "value": "claude", "description": "Filter by provider slug (e.g. \"claude\").", "disabled": false }, { "key": "from", "value": "2026-03-01", "description": "date Start of date range (inclusive, YYYY-MM-DD).", "disabled": false }, { "key": "to", "value": "2026-03-25", "description": "date End of date range (inclusive, YYYY-MM-DD). Must be on or after `from`.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page. Min 1, max 100. Defaults to 25.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ai-tooling\/usage?actor_id=42&provider=claude&from=2026-03-01&to=2026-03-25&per_page=25" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"actor_id\":11,\"provider\":\"pzdszigdqrrkthqp\",\"from\":\"2026-04-13T21:34:33\",\"to\":\"2069-05-04\",\"per_page\":4}" }, "description": "Returns a paginated list of daily usage records across all matched and unmatched actors.\nRecords are ordered by `usage_date` descending (most recent first). Each record represents\none actor's usage of one AI tooling provider on a single day.\n\nSupports filtering by actor, provider, and date range. Unmatched records (where the\nsource email could not be resolved to an Orgonaut actor) have `actor_id: null`.\n\nRequires `ai-tooling.manage` ability." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 128,\n \"actor_id\": 42,\n \"provider\": \"claude\",\n \"source_email\": \"aoife.ryan@example.com\",\n \"usage_date\": \"2026-03-24\",\n \"sessions_count\": 5,\n \"lines_added\": 320,\n \"lines_removed\": 85,\n \"commits_count\": 4,\n \"pull_requests_count\": 1,\n \"total_input_tokens\": 125000,\n \"total_output_tokens\": 48000,\n \"total_cache_read_tokens\": 32000,\n \"total_cache_creation_tokens\": 8000,\n \"total_cost_cents\": 245,\n \"currency\": \"USD\",\n \"tool_actions\": {\"edit_tool\": {\"accepted\": 18, \"rejected\": 2}, \"bash_tool\": {\"accepted\": 12, \"rejected\": 0}},\n \"model_breakdown\": [{\"model\": \"claude-opus-4-6\", \"input_tokens\": 80000, \"output_tokens\": 30000}, {\"model\": \"claude-sonnet-4-6\", \"input_tokens\": 45000, \"output_tokens\": 18000}],\n \"matched_at\": \"2026-03-24T03:15:42+00:00\",\n \"actor\": {\"id\": 42, \"name\": \"Aoife Ryan\", \"email\": \"aoife.ryan@example.com\"}\n }\n ],\n \"links\": {\"first\": \"\/?page=1\", \"last\": \"\/?page=3\", \"prev\": null, \"next\": \"\/?page=2\"},\n \"meta\": {\"current_page\": 1, \"last_page\": 3, \"per_page\": 25, \"total\": 72}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"The given data was invalid.\", \"errors\": {\"to\": [\"The to field must be a date after or equal to from.\"]}}", "name": "" } ] }, { "name": "AI Tooling \u2014 Actor summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ai-tooling\/actors\/:actor_id\/summary", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ai-tooling\/actors\/:actor_id\/summary", "variable": [ { "id": "actor_id", "key": "actor_id", "value": "11", "description": "The ID of the actor." }, { "id": "actor", "key": "actor", "value": "42", "description": "The actor ID." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns aggregated AI tooling cost and usage totals for a single actor. Includes the\nlast full calendar month total, month-to-date total, and a per-provider breakdown.\n\nUseful for actor profile cards and dashboards.\n\nRequires `ai-tooling.manage` ability." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"actor_id\": 42,\n \"has_data\": true,\n \"monthly_cost_cents\": 850,\n \"mtd_cost_cents\": 320,\n \"sessions\": 15,\n \"commits\": 8,\n \"prs\": 2,\n \"lines_added\": 450,\n \"lines_removed\": 120,\n \"by_provider\": {\n \"claude\": {\n \"cost_cents\": 850,\n \"mtd_cost_cents\": 320,\n \"sessions\": 15\n }\n }\n }\n}", "name": "" } ] }, { "name": "AI Tooling \u2014 Actor daily series", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ai-tooling\/actors\/:actor_id\/series", "query": [ { "key": "from", "value": "2025-10-01", "description": "date Start of date range (YYYY-MM-DD). Defaults to 6 months ago (start of month).", "disabled": false }, { "key": "to", "value": "2026-03-25", "description": "date End of date range (YYYY-MM-DD). Must be on or after `from`. Defaults to today.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ai-tooling\/actors\/:actor_id\/series?from=2025-10-01&to=2026-03-25", "variable": [ { "id": "actor_id", "key": "actor_id", "value": "11", "description": "The ID of the actor." }, { "id": "actor", "key": "actor", "value": "42", "description": "The actor ID." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2026-04-13T21:34:33\",\"to\":\"2069-05-04\"}" }, "description": "Returns a daily time series of AI tooling usage for a single actor. Each data point\ncontains cost, token consumption, session count, and code-change metrics for one day.\nDesigned for rendering cost trend and activity charts on actor profile pages.\n\nDefaults to the last 6 months when `from`\/`to` are omitted.\n\nRequires `ai-tooling.manage` ability." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"date\": \"2026-03-23\",\n \"cost_cents\": 120,\n \"sessions\": 3,\n \"commits\": 2,\n \"prs\": 0,\n \"lines_added\": 180,\n \"lines_removed\": 45,\n \"input_tokens\": 52000,\n \"output_tokens\": 19000\n },\n {\n \"date\": \"2026-03-24\",\n \"cost_cents\": 245,\n \"sessions\": 5,\n \"commits\": 4,\n \"prs\": 1,\n \"lines_added\": 320,\n \"lines_removed\": 85,\n \"input_tokens\": 125000,\n \"output_tokens\": 48000\n }\n ]\n}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"The given data was invalid.\", \"errors\": {\"to\": [\"The to field must be a date after or equal to from.\"]}}", "name": "" } ] }, { "name": "AI Tooling \u2014 Team summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ai-tooling\/teams\/:team_id\/summary", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ai-tooling\/teams\/:team_id\/summary", "variable": [ { "id": "team_id", "key": "team_id", "value": "11", "description": "The ID of the team." }, { "id": "team", "key": "team", "value": "7", "description": "The team ID." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns aggregated AI tooling cost and usage totals for all actors placed in the team's\norg unit. Covers the last full calendar month and month-to-date period.\n\nIf the team has no associated org unit, zeroed metrics are returned.\n\nRequires `ai-tooling.manage` ability." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"team_id\": 7,\n \"monthly_cost_cents\": 2500,\n \"mtd_cost_cents\": 1200,\n \"sessions\": 45,\n \"commits\": 22,\n \"prs\": 6,\n \"lines_added\": 1800,\n \"lines_removed\": 400\n }\n}", "name": "" } ] }, { "name": "AI Tooling \u2014 Department summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ai-tooling\/departments\/:department_id\/summary", "query": [ { "key": "scope", "value": "subtree", "description": "Aggregation scope: \"direct\" (department org unit only) or \"subtree\" (all descendants). Defaults to \"subtree\".", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ai-tooling\/departments\/:department_id\/summary?scope=subtree", "variable": [ { "id": "department_id", "key": "department_id", "value": "11", "description": "The ID of the department." }, { "id": "department", "key": "department", "value": "3", "description": "The department ID." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns aggregated AI tooling cost and usage totals for a department. By default,\naggregates across the entire department subtree (all descendant org units). Pass\n`scope=direct` to limit to actors placed directly in the department's own org unit.\n\nIf the department has no associated org unit, zeroed metrics are returned.\n\nRequires `ai-tooling.manage` ability." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"department_id\": 3,\n \"scope\": \"subtree\",\n \"monthly_cost_cents\": 8500,\n \"mtd_cost_cents\": 3200,\n \"sessions\": 120,\n \"commits\": 55,\n \"prs\": 12,\n \"lines_added\": 5000,\n \"lines_removed\": 1200\n }\n}", "name": "" } ] } ] }, { "name": "Actors", "description": "", "item": [ { "name": "Actors \u2014 List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Max 100.", "disabled": false }, { "key": "sort", "value": "-created_at%2Cname", "description": "Comma-separated columns, prefix with - for DESC. Allowed: id,name,created_at.", "disabled": false }, { "key": "filter%5Bstatus%5D", "value": "active", "description": "Filter by status.", "disabled": false }, { "key": "filter%5Bdepartment_id%5D", "value": "5", "description": "Filter by department id. Uses the department org unit mapping derived from `org_unit_actor`.", "disabled": false }, { "key": "filter%5Borg_unit_id%5D", "value": "10", "description": "Filter by org unit id (department or team subtree).", "disabled": false }, { "key": "fields%5Bactors%5D", "value": "id%2Cfirst_name%2Clast_name", "description": "Sparse fields for actors.", "disabled": false }, { "key": "include", "value": "manager%2Cteam", "description": "Comma-separated expansions. Allowed: manager,org_units,team,department. The `team`\/`department` flags surface computed placement data.", "disabled": false }, { "key": "as_of", "value": "2025-09-01", "description": "The date\/datetime used for time-window checks. Defaults to now.", "disabled": false }, { "key": "scenario_id", "value": "4", "description": "The scenario ID to scope results. Omit or pass `scenario_id=null` for baseline data.", "disabled": false }, { "key": "with_counts", "value": "reports", "description": "Comma-separated relationship counts. Allowed: reports.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/actors?page=1&per_page=25&sort=-created_at%2Cname&filter%5Bstatus%5D=active&filter%5Bdepartment_id%5D=5&filter%5Borg_unit_id%5D=10&fields%5Bactors%5D=id%2Cfirst_name%2Clast_name&include=manager%2Cteam&as_of=2025-09-01&scenario_id=4&with_counts=reports" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns actors with their primary team resolved from primary org-unit placements (primary=true) inside\nthe active scenario context.\n\nRequires `actors.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 44,\n \"first_name\": \"Aoife\",\n \"last_name\": \"Ryan\",\n \"name\": \"Aoife Ryan\",\n \"email\": \"aoife.ryan@example.com\",\n \"manager_id\": 2,\n \"team\": {\n \"id\": 15,\n \"name\": \"Team C\u00faChulainn\",\n \"team_type\": {\n \"id\": 3,\n \"name\": \"Product Squad\",\n \"slug\": \"product-squad\"\n }\n },\n \"department\": {\"id\": 3, \"name\": \"Engineering\"}\n }\n ]\n}", "name": "" }, { "header": [], "code": 400, "body": "{\"code\":\"query.invalid_parameter\",\"message\":\"Unsupported sort: salary\",\"details\":{\"allowed\":[\"id\",\"name\",\"created_at\"]}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"per_page\":[\"The per page must be at least 1.\"]}}", "name": "" } ] }, { "name": "Store a newly created actor.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors", "query": [], "raw": "{{baseUrl}}\/api\/v1\/actors" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"Aoife\",\"last_name\":\"Ryan\",\"email\":\"aoife.ryan@example.com\",\"external_uid\":\"01J9ZQ4J6W2Q0WJ9V6YV5NPQ4W\",\"kind\":\"human\",\"status\":\"active\",\"fte\":2306379,\"position_id\":42,\"create_placement\":true,\"location\":\"Dublin, IE\",\"start_date\":\"2025-09-01\",\"end_date\":\"2025-09-30\",\"manager_id\":2,\"agent_profile\":{\"provider\":\"openai\",\"orchestrator\":\"langgraph\",\"meta\":{\"capabilities\":[\"search\"]},\"endpoint_base_url\":\"https:\\\/\\\/api.openai.com\",\"model_default\":\"gpt-4.1\"}}" }, "description": "Requires `actors.create` ability.\nManager must belong to the same tenant and cannot reference the actor themselves." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":44,\"first_name\":\"Aoife\",\"last_name\":\"Ryan\",\"name\":\"Aoife Ryan\",\"email\":\"aoife.ryan@example.com\",\"kind\":\"human\",\"status\":\"active\",\"contract_type\":\"perm\",\"manager_id\":2,\"start_date\":\"2025-09-01\",\"end_date\":\"2025-09-30\",\"created_at\":\"2025-01-10T09:00:00Z\"}}", "name": "" }, { "header": [], "code": 429, "body": "{\"code\":\"limit.actors\",\"message\":\"Actor plan limit reached (250\/250). Upgrade your plan to add more people.\",\"limit\":250,\"current\":250}", "name": "" } ] }, { "name": "Actors \u2014 Show", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:id", "query": [ { "key": "include", "value": "manager%2Cteam", "description": "Comma-separated expansions. Allowed: manager,org_units,team,department. The `team`\/`department` flags surface computed placement data.", "disabled": false }, { "key": "as_of", "value": "2025-09-01", "description": "The date\/datetime used for time-window checks. Defaults to now.", "disabled": false }, { "key": "scenario_id", "value": "", "description": "The scenario context to resolve against. Defaults to current (baseline if none).", "disabled": true }, { "key": "with_counts", "value": "reports", "description": "Comma-separated relationship counts. Allowed: reports.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/actors\/:id?include=manager%2Cteam&as_of=2025-09-01&scenario_id=&with_counts=reports", "variable": [ { "id": "id", "key": "id", "value": "44", "description": "The ID of the actor." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns an actor with their primary team resolved from primary org-unit placement (primary=true) within\nthe active scenario context.\n\nRequires a Sanctum token with the `actors.read` ability and an `X-Tenant` header." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 44,\n \"first_name\": \"Aoife\",\n \"last_name\": \"Ryan\",\n \"name\": \"Aoife Ryan\",\n \"email\": \"aoife.ryan@example.com\",\n \"kind\": \"human\",\n \"status\": \"active\",\n \"contract_type\": \"perm\",\n \"manager_id\": 2,\n \"manager\": {\"id\":2,\"first_name\":\"Brian\",\"last_name\":\"O'Neil\",\"name\":\"Brian O'Neil\"},\n \"reports_count\": 3,\n \"team\": {\n \"id\": 15,\n \"name\": \"Team C\u00faChulainn\",\n \"team_type\": {\n \"id\": 3,\n \"name\": \"Product Squad\",\n \"slug\": \"product-squad\"\n }\n },\n \"department\": {\"id\":3,\"name\":\"Engineering\"},\n \"created_at\": \"2025-01-10T09:00:00Z\"\n }\n}", "name": "" } ] }, { "name": "Update the specified actor.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/actors\/:id", "variable": [ { "id": "id", "key": "id", "value": "44", "description": "The ID of the actor." } ] }, "method": "PUT", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"Aoife\",\"last_name\":\"Ryan\",\"email\":\"aoife.ryan@example.com\",\"external_uid\":\"01J9ZQ4J6W2Q0WJ9V6YV5NPQ4W\",\"kind\":\"human\",\"status\":\"active\",\"fte\":2306379,\"position_id\":42,\"create_placement\":true,\"location\":\"Dublin, IE\",\"start_date\":\"2025-09-01\",\"end_date\":\"2025-09-30\",\"manager_id\":2,\"agent_profile\":{\"provider\":\"openai\",\"orchestrator\":\"langgraph\",\"meta\":{\"capabilities\":[\"search\"]}}}" }, "description": "Requires `actors.update` ability and an `X-Tenant` header.\nManager must belong to the same tenant and cannot reference the actor themselves." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 44,\n \"first_name\": \"Aoife\",\n \"last_name\": \"Ryan\",\n \"name\": \"Aoife Ryan\",\n \"email\": \"aoife.ryan@example.com\",\n \"kind\": \"human\",\n \"status\": \"active\",\n \"manager_id\": 2,\n \"team\": {\"id\":15,\"name\":\"Team C\u00faChulainn\"},\n \"department\": {\"id\":3,\"name\":\"Engineering\"},\n \"created_at\": \"2025-01-10T09:00:00Z\"\n }\n}", "name": "" } ] }, { "name": "Remove the specified actor.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/actors\/:id", "variable": [ { "id": "id", "key": "id", "value": "44", "description": "The ID of the actor." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `actors.delete` ability and an `X-Tenant` header." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Actor compensations \u2014 List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:actor_id\/compensations", "query": [ { "key": "scenario_id", "value": "4", "description": "Scenario id to scope results; omit or pass null for baseline only.", "disabled": false }, { "key": "as_of", "value": "2025-03-01", "description": "Date used to flag current slices.", "disabled": false }, { "key": "include", "value": "scenario", "description": "Comma-separated relationships. Allowed: scenario,actor.", "disabled": false }, { "key": "fields%5Bactor_compensations%5D", "value": "id%2Ccurrency%2Cbase_salary_cents", "description": "Sparse fieldset.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/actors\/:actor_id\/compensations?scenario_id=4&as_of=2025-03-01&include=scenario&fields%5Bactor_compensations%5D=id%2Ccurrency%2Cbase_salary_cents", "variable": [ { "id": "actor_id", "key": "actor_id", "value": "11", "description": "The ID of the actor." }, { "id": "actor", "key": "actor", "value": "11", "description": "The actor identifier." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists compensation slices for the given actor. When a scenario context is supplied,\nscenario slices are returned alongside baseline fallbacks, ordered with scenario data first.\n\nRequires `actors.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"currency\":\"USD\",\"base_salary_cents\":12000000}]}", "name": "" } ] }, { "name": "Actor compensations \u2014 Create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:actor_id\/compensations", "query": [ { "key": "include", "value": "scenario", "description": "Comma-separated relationships. Allowed: scenario,actor.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/actors\/:actor_id\/compensations?include=scenario", "variable": [ { "id": "actor_id", "key": "actor_id", "value": "11", "description": "The ID of the actor." }, { "id": "actor", "key": "actor", "value": "11", "description": "The actor identifier." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"scenario_id\":3,\"employment_type\":\"Permanent\",\"currency\":\"USD\",\"base_salary_cents\":12000000,\"daily_rate_cents\":45000,\"valid_from\":\"2025-01-01\",\"valid_to\":\"2025-12-31\",\"meta\":{\"note\":\"Includes sign-on bonus\"}}" }, "description": "Stores a new compensation slice for the actor.\n\nRequires `actors.update` ability." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":9,\"currency\":\"EUR\",\"daily_rate_cents\":55000}}", "name": "" } ] }, { "name": "Actor compensations \u2014 Update", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:actor_id\/compensations\/:id", "query": [ { "key": "include", "value": "scenario", "description": "Comma-separated relationships. Allowed: scenario,actor.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/actors\/:actor_id\/compensations\/:id?include=scenario", "variable": [ { "id": "actor_id", "key": "actor_id", "value": "11", "description": "The ID of the actor." }, { "id": "id", "key": "id", "value": "11", "description": "The ID of the compensation." }, { "id": "actor", "key": "actor", "value": "11", "description": "The actor identifier." }, { "id": "compensation", "key": "compensation", "value": "11", "description": "The compensation identifier." } ] }, "method": "PATCH", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"scenario_id\":3,\"employment_type\":\"Contractor\",\"currency\":\"GBP\",\"base_salary_cents\":9800000,\"daily_rate_cents\":60000,\"valid_from\":\"2025-02-01\",\"valid_to\":\"2025-09-30\",\"meta\":{\"note\":\"Updated after promotion\"}}" }, "description": "Updates an existing compensation slice for the actor.\n\nRequires `actors.update` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":9,\"currency\":\"USD\",\"base_salary_cents\":9900000}}", "name": "" } ] }, { "name": "Actor compensations \u2014 Delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:actor_id\/compensations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/actors\/:actor_id\/compensations\/:id", "variable": [ { "id": "actor_id", "key": "actor_id", "value": "11", "description": "The ID of the actor." }, { "id": "id", "key": "id", "value": "11", "description": "The ID of the compensation." }, { "id": "actor", "key": "actor", "value": "11", "description": "The actor identifier." }, { "id": "compensation", "key": "compensation", "value": "11", "description": "The compensation identifier." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Soft deletes a compensation slice.\n\nRequires `actors.delete` ability." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Aggregates", "description": "", "item": [ { "name": "Queue recalculation of cached aggregates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aggregates\/recalculate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aggregates\/recalculate" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"queued\"}", "name": "" } ] } ] }, { "name": "Astro", "description": "", "item": [ { "name": "List Astro capabilities for the current tenant, user, and context.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/astro\/capabilities", "query": [ { "key": "category", "value": "work_with_scenarios", "description": "Filter by category key.", "disabled": false }, { "key": "kind", "value": "read", "description": "Filter by capability kind.", "disabled": false }, { "key": "availability", "value": "available", "description": "Filter by computed availability.", "disabled": false }, { "key": "include_unavailable", "value": "", "description": "Include capabilities that are unavailable in the current context.", "disabled": true }, { "key": "view_mode", "value": "scenario", "description": "Override the current Astro view mode (live, scenario, snapshot).", "disabled": false }, { "key": "scenario_id", "value": "7", "description": "Optional scenario id used for scenario- or snapshot-scoped discovery.", "disabled": false }, { "key": "focused_entity_type", "value": "team", "description": "Optional focused entity type (actor, department, org_unit, scenario, team).", "disabled": false }, { "key": "focused_entity_id", "value": "12", "description": "Optional focused entity id.", "disabled": false }, { "key": "as_of", "value": "2026-03-01", "description": "date Optional as-of date for scoped discovery.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/astro\/capabilities?category=work_with_scenarios&kind=read&availability=available&include_unavailable=&view_mode=scenario&scenario_id=7&focused_entity_type=team&focused_entity_id=12&as_of=2026-03-01" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"key\":\"explore_organisation\",\"title\":\"Explore organisation\",\"description\":\"Browse the current organisation structure, departments, teams, and root summaries.\",\"capabilities\":[{\"key\":\"explore.organisation\",\"title\":\"Explore organisation structure\",\"kind\":\"read\",\"availability_status\":\"available\"}]}],\"meta\":{\"context\":{\"view_mode\":\"live\",\"scope_key\":\"baseline\"},\"counts\":{\"available\":5,\"limited\":2,\"unavailable\":0,\"coming_soon\":3}}}", "name": "" } ] }, { "name": "Show one Astro capability for the current tenant, user, and context.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/astro\/capabilities\/:key", "query": [ { "key": "view_mode", "value": "scenario", "description": "Override the current Astro view mode (live, scenario, snapshot).", "disabled": false }, { "key": "scenario_id", "value": "7", "description": "Optional scenario id used for scenario- or snapshot-scoped discovery.", "disabled": false }, { "key": "focused_entity_type", "value": "team", "description": "Optional focused entity type (actor, department, org_unit, scenario, team).", "disabled": false }, { "key": "focused_entity_id", "value": "12", "description": "Optional focused entity id.", "disabled": false }, { "key": "as_of", "value": "2026-03-01", "description": "date Optional as-of date for scoped discovery.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/astro\/capabilities\/:key?view_mode=scenario&scenario_id=7&focused_entity_type=team&focused_entity_id=12&as_of=2026-03-01", "variable": [ { "id": "key", "key": "key", "value": "explore.organisation", "description": "Capability key." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"key\":\"explore.organisation\",\"title\":\"Explore organisation structure\",\"kind\":\"read\",\"availability_status\":\"available\",\"examples\":[{\"prompt\":\"List the departments in the current scope.\"}]}}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Capability not found.\"}", "name": "" } ] } ] }, { "name": "Auth\/Tokens", "description": "", "item": [ { "name": "List the authenticated user's tokens.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tokens" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 12,\n \"name\": \"CI\/CD Bot\",\n \"abilities\": [\"actors.read\", \"scenarios.update\"],\n \"last_used_at\": \"2025-08-01T09:30:12Z\",\n \"created_at\": \"2025-07-15T12:00:00Z\",\n \"updated_at\": \"2025-08-01T09:30:12Z\"\n }\n]", "name": "" } ] }, { "name": "Revoke a token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tokens\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tokens\/:id", "variable": [ { "id": "id", "key": "id", "value": "ab", "description": "The ID of the token." }, { "id": "token", "key": "token", "value": "11", "description": "The token ID." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Rotate a token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tokens\/:token\/rotate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tokens\/:token\/rotate", "variable": [ { "id": "token", "key": "token", "value": "11", "description": "The token ID." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"1|abcdef123456\"}", "name": "" } ] }, { "name": "Rename a token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tokens\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tokens\/:id", "variable": [ { "id": "id", "key": "id", "value": "ab", "description": "The ID of the token." }, { "id": "token", "key": "token", "value": "11", "description": "The token ID." } ] }, "method": "PATCH", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"CI bot token\"}" }, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Issue a new actoral access token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tokens" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug for token scope. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"loma53@example.com\",\"password\":\"secret-password-123\",\"name\":\"CI\\\/CD Bot\",\"abilities\":[\"actors.read\",\"scenarios.update\"]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"token\":\"1|abcdef123456\"}", "name": "" }, { "header": [], "code": 403, "body": "{\"code\":\"auth.forbidden\",\"message\":\"Forbidden.\"}", "name": "" }, { "header": [], "code": 429, "body": "{\"code\":\"limit.api_tokens\",\"message\":\"API token plan limit reached (1\/1). Revoke an existing token or upgrade your plan.\",\"limit\":1,\"current\":1}", "name": "" } ] } ] }, { "name": "Costs", "description": "", "item": [ { "name": "Agent Cost Events \u2014 Create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actor-cost-events", "query": [], "raw": "{{baseUrl}}\/api\/v1\/actor-cost-events" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"occurred_at\":\"2025-09-01T12:00:00Z\",\"amount\":42.55,\"currency\":\"USD\",\"idempotency_key\":\"evt_01HX...\",\"actor_id\":44,\"org_unit_id\":12,\"scenario_id\":3,\"model\":\"gpt-4.1\",\"input_tokens\":1200000,\"cached_input_tokens\":250000,\"output_tokens\":640000,\"meta\":{\"refund\":false}}" }, "description": "Ingest a machine cost event with idempotency protection. Duplicate idempotency keys\nreturn the existing event instead of creating a new row." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"actor_id\":44,\"actor_agent_profile_id\":9,\"org_unit_id\":12,\"scenario_id\":null,\"occurred_at\":\"2025-09-01T12:00:00Z\",\"input_tokens\":1200000,\"cached_input_tokens\":250000,\"output_tokens\":640000,\"amount\":18.75,\"currency\":\"USD\",\"provider\":\"openai\",\"model\":\"gpt-4.1\",\"meta\":{\"refund\":false},\"created_at\":\"2025-09-02T10:00:00Z\"}}", "name": "" }, { "header": [], "code": 201, "body": "{\"data\":{\"id\":1,\"actor_id\":44,\"actor_agent_profile_id\":9,\"org_unit_id\":12,\"scenario_id\":null,\"occurred_at\":\"2025-09-01T12:00:00Z\",\"input_tokens\":1200000,\"cached_input_tokens\":250000,\"output_tokens\":640000,\"amount\":18.75,\"currency\":\"USD\",\"provider\":\"openai\",\"model\":\"gpt-4.1\",\"meta\":{\"refund\":false},\"created_at\":\"2025-09-02T10:00:00Z\"}}", "name": "" } ] }, { "name": "AI Model Costs \u2014 List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/settings\/ai\/costs", "query": [ { "key": "sort", "value": "-effective_from%2Cprovider", "description": "Comma-separated sort list. Allowed: id,provider,model,effective_from,effective_to,created_at. Prefix with `-` for descending order.", "disabled": false }, { "key": "filter%5Bprovider%5D", "value": "openai", "description": "Filter by provider slug.", "disabled": false }, { "key": "filter%5Bmodel%5D", "value": "gpt-4.1", "description": "Filter by model identifier.", "disabled": false }, { "key": "filter%5Bcurrency%5D", "value": "USD", "description": "Filter by currency code.", "disabled": false }, { "key": "fields%5Bai_model_costs%5D", "value": "id%2Cprovider%2Cmodel%2Ccurrency%2Cis_active", "description": "Sparse fieldset for AI model costs.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/settings\/ai\/costs?sort=-effective_from%2Cprovider&filter%5Bprovider%5D=openai&filter%5Bmodel%5D=gpt-4.1&filter%5Bcurrency%5D=USD&fields%5Bai_model_costs%5D=id%2Cprovider%2Cmodel%2Ccurrency%2Cis_active" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List tenant-global model pricing rows." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":11,\"provider\":\"openai\",\"model\":\"gpt-4.1\",\"currency\":\"USD\",\"input_mtok_price\":5,\"cached_input_mtok_price\":0.5,\"output_mtok_price\":15,\"effective_from\":\"2026-01-01\",\"effective_to\":null,\"is_active\":true,\"created_at\":\"2026-03-07T09:00:00Z\",\"updated_at\":\"2026-03-07T09:00:00Z\"}],\"links\":{\"first\":null,\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":1,\"total\":1}}", "name": "" } ] }, { "name": "AI Model Costs \u2014 Create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/settings\/ai\/costs", "query": [], "raw": "{{baseUrl}}\/api\/v1\/settings\/ai\/costs" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"provider\":\"openai\",\"model\":\"gpt-4.1\",\"currency\":\"USD\",\"input_mtok_price\":5,\"cached_input_mtok_price\":0.5,\"output_mtok_price\":15,\"effective_from\":\"2026-01-01\",\"effective_to\":\"2026-06-30\"}" }, "description": "Create a tenant-global model pricing row." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":11,\"provider\":\"openai\",\"model\":\"gpt-4.1\",\"currency\":\"USD\",\"input_mtok_price\":5,\"cached_input_mtok_price\":0.5,\"output_mtok_price\":15,\"effective_from\":\"2026-01-01\",\"effective_to\":null,\"is_active\":true,\"created_at\":\"2026-03-07T09:00:00Z\",\"updated_at\":\"2026-03-07T09:00:00Z\"}}", "name": "" } ] }, { "name": "AI Model Costs \u2014 Show", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/settings\/ai\/costs\/:ai_model_cost", "query": [ { "key": "fields%5Bai_model_costs%5D", "value": "id%2Cprovider%2Cmodel%2Ccurrency%2Cis_active", "description": "Sparse fieldset for AI model costs.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/settings\/ai\/costs\/:ai_model_cost?fields%5Bai_model_costs%5D=id%2Cprovider%2Cmodel%2Ccurrency%2Cis_active", "variable": [ { "id": "ai_model_cost", "key": "ai_model_cost", "value": "11", "description": "The AI model cost row id." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a single tenant-global model pricing row." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":11,\"provider\":\"openai\",\"model\":\"gpt-4.1\",\"currency\":\"USD\",\"input_mtok_price\":5,\"cached_input_mtok_price\":0.5,\"output_mtok_price\":15,\"effective_from\":\"2026-01-01\",\"effective_to\":null,\"is_active\":true,\"created_at\":\"2026-03-07T09:00:00Z\",\"updated_at\":\"2026-03-07T09:00:00Z\"}}", "name": "" } ] }, { "name": "AI Model Costs \u2014 Update", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/settings\/ai\/costs\/:ai_model_cost", "query": [], "raw": "{{baseUrl}}\/api\/v1\/settings\/ai\/costs\/:ai_model_cost", "variable": [ { "id": "ai_model_cost", "key": "ai_model_cost", "value": "11", "description": "The AI model cost row id." } ] }, "method": "PATCH", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"provider\":\"openai\",\"model\":\"gpt-4.1\",\"currency\":\"USD\",\"input_mtok_price\":5,\"cached_input_mtok_price\":0.5,\"output_mtok_price\":15,\"effective_from\":\"2026-01-01\",\"effective_to\":\"2026-06-30\"}" }, "description": "Update a tenant-global model pricing row." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":11,\"provider\":\"openai\",\"model\":\"gpt-4.1-mini\",\"currency\":\"USD\",\"input_mtok_price\":0.8,\"cached_input_mtok_price\":0.2,\"output_mtok_price\":3.2,\"effective_from\":\"2026-03-01\",\"effective_to\":null,\"is_active\":true,\"created_at\":\"2026-03-07T09:00:00Z\",\"updated_at\":\"2026-03-07T10:15:00Z\"}}", "name": "" } ] }, { "name": "AI Model Costs \u2014 Delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/settings\/ai\/costs\/:ai_model_cost", "query": [], "raw": "{{baseUrl}}\/api\/v1\/settings\/ai\/costs\/:ai_model_cost", "variable": [ { "id": "ai_model_cost", "key": "ai_model_cost", "value": "11", "description": "The AI model cost row id." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a tenant-global model pricing row." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Department Types", "description": "", "item": [ { "name": "Return the top matching Department Types for the active tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/department-types\/search", "query": [ { "key": "q", "value": "ops", "description": "Search term applied to name and slug.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/department-types\/search?q=ops" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `departments.read` ability." }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1,\"name\":\"Operations\",\"slug\":\"operations\",\"color\":\"#008080\"}]", "name": "" } ] }, { "name": "Create a Department Type for the active tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/department-types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/department-types" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Operations\",\"slug\":\"ops\",\"color\":\"#008080\",\"description\":\"Supports company-wide services\"}" }, "description": "Requires `departments.create` ability." }, "response": [ { "header": [], "code": 201, "body": "{\"id\":3,\"name\":\"Operations\",\"slug\":\"operations\",\"color\":\"#008080\"}", "name": "" } ] } ] }, { "name": "Departments", "description": "", "item": [ { "name": "Display a paginated listing of departments.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Max 100.", "disabled": false }, { "key": "sort", "value": "-created_at%2Cname", "description": "Comma-separated columns, prefix with - for DESC. Allowed: id,name,created_at.", "disabled": false }, { "key": "filter%5Blead_id%5D", "value": "44", "description": "Filter by lead.", "disabled": false }, { "key": "fields%5Bdepartments%5D", "value": "id%2Cname%2Cdepartment_type_id", "description": "Sparse fields for departments.", "disabled": false }, { "key": "include", "value": "lead%2CdepartmentType", "description": "Comma-separated relationships. Allowed: lead,departmentType,parentDepartment,aggregate.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/departments?page=1&per_page=25&sort=-created_at%2Cname&filter%5Blead_id%5D=44&fields%5Bdepartments%5D=id%2Cname%2Cdepartment_type_id&include=lead%2CdepartmentType" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `departments.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":3,\"name\":\"Engineering\",\"lead_id\":44,\"department_type_id\":7,\"department_type\":{\"id\":7,\"name\":\"Division\",\"slug\":\"division\",\"color\":\"#0052cc\"},\"parent_department_id\":2,\"parent_department\":{\"id\":2,\"name\":\"Product\"},\"is_active\":true,\"description\":\"Platform engineering for core services.\"}],\"links\":{\"first\":null,\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"total\":1,\"current_page\":1,\"per_page\":15,\"last_page\":1}}", "name": "" }, { "header": [], "code": 400, "body": "{\"code\":\"query.invalid_parameter\",\"message\":\"Unsupported sort: salary\",\"details\":{\"allowed\":[\"id\",\"name\",\"created_at\"]}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"per_page\":[\"The per page must be at least 1.\"]}}", "name": "" } ] }, { "name": "Store a newly created department.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Engineering\",\"department_type_id\":5,\"parent_org_unit_id\":42,\"cost_center\":\"ENG-1001\",\"department_lead_id\":44,\"is_active\":true,\"description\":\"Supports the full product org.\"}" }, "description": "Requires `departments.create` ability." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":3,\"name\":\"Engineering\",\"lead_id\":44,\"cost_center\":\"ENG-001\",\"department_type_id\":7,\"department_type\":{\"id\":7,\"name\":\"Division\",\"slug\":\"division\",\"color\":\"#0052cc\"},\"parent_department_id\":null,\"parent_department\":null,\"is_active\":true,\"description\":\"Owns platform reliability.\"}}", "name": "" } ] }, { "name": "Display a specific department.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the department." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `departments.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":3,\"name\":\"Engineering\",\"lead_id\":44,\"cost_center\":\"ENG-001\",\"department_type_id\":7,\"department_type\":{\"id\":7,\"name\":\"Division\",\"slug\":\"division\",\"color\":\"#0052cc\"},\"parent_department_id\":2,\"parent_department\":{\"id\":2,\"name\":\"Product\"},\"is_active\":true,\"description\":\"Platform engineering for core services.\"}}", "name": "" } ] }, { "name": "Update a department.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the department." } ] }, "method": "PUT", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Engineering\",\"department_type_id\":5,\"parent_org_unit_id\":42,\"department_lead_id\":44,\"cost_center\":\"ENG-1001\",\"is_active\":true,\"description\":\"Supports the full product org.\"}" }, "description": "Requires `departments.update` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":3,\"name\":\"Engineering & Infrastructure\",\"lead_id\":44,\"cost_center\":\"ENG-001\",\"department_type_id\":7,\"department_type\":{\"id\":7,\"name\":\"Division\",\"slug\":\"division\",\"color\":\"#0052cc\"},\"parent_department_id\":2,\"parent_department\":{\"id\":2,\"name\":\"Product\"},\"is_active\":true,\"description\":\"Platform engineering for core services.\"}}", "name": "" } ] }, { "name": "Delete a department.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the department." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `departments.delete` ability." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Initiatives", "description": "", "item": [ { "name": "Display a paginated listing of initiatives.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/initiatives", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Max 100.", "disabled": false }, { "key": "sort", "value": "-created_at%2Ctitle", "description": "Comma-separated columns, prefix with - for DESC. Allowed: id,title,created_at.", "disabled": false }, { "key": "search", "value": "cost", "description": "Search by title or description.", "disabled": false }, { "key": "filter%5Bstatus%5D", "value": "active", "description": "Filter by status.", "disabled": false }, { "key": "filter%5Bbaseline_scenario_id%5D", "value": "1", "description": "Filter by baseline scenario.", "disabled": false }, { "key": "filter%5Btarget_scenario_id%5D", "value": "2", "description": "Filter by target scenario.", "disabled": false }, { "key": "fields%5Binitiatives%5D", "value": "id%2Ctitle", "description": "Sparse fields for initiatives.", "disabled": false }, { "key": "include", "value": "baseline_scenario%2Ctarget_scenario", "description": "Comma-separated relationships. Allowed: baseline_scenario,target_scenario.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/initiatives?page=1&per_page=25&sort=-created_at%2Ctitle&search=cost&filter%5Bstatus%5D=active&filter%5Bbaseline_scenario_id%5D=1&filter%5Btarget_scenario_id%5D=2&fields%5Binitiatives%5D=id%2Ctitle&include=baseline_scenario%2Ctarget_scenario" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `initiatives.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"title\":\"Cost Reduction\",\"status\":\"active\"},{\"id\":2,\"title\":\"Mobile Workforce Rollout\",\"status\":\"draft\"}],\"links\":{\"first\":null,\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"total\":4,\"current_page\":1,\"per_page\":15,\"last_page\":1}}", "name": "" }, { "header": [], "code": 400, "body": "{\"code\":\"query.invalid_parameter\",\"message\":\"Unsupported sort: salary\",\"details\":{\"allowed\":[\"id\",\"title\",\"created_at\"]}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"per_page\":[\"The per page must be at least 1.\"]}}", "name": "" } ] }, { "name": "Store a newly created initiative.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/initiatives", "query": [ { "key": "fields%5Binitiatives%5D", "value": "id%2Ctitle", "description": "Sparse fields for initiatives.", "disabled": false }, { "key": "include", "value": "baseline_scenario%2Ctarget_scenario", "description": "Comma-separated relationships. Allowed: baseline_scenario,target_scenario.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/initiatives?fields%5Binitiatives%5D=id%2Ctitle&include=baseline_scenario%2Ctarget_scenario" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Reduce Cloud Spend\",\"description\":\"Target a 15% reduction by Q4.\",\"status\":\"active\",\"baseline_scenario_id\":1,\"target_scenario_id\":2}" }, "description": "Requires `initiatives.create` ability." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":1,\"title\":\"Cost Reduction\",\"description\":\"Reduce infrastructure spend by 15%\",\"status\":\"active\",\"baseline_scenario_id\":1,\"target_scenario_id\":2}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"title\":[\"The title field is required.\"]}}", "name": "" } ] }, { "name": "Display a specific initiative.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/initiatives\/:id", "query": [ { "key": "fields%5Binitiatives%5D", "value": "id%2Ctitle", "description": "Sparse fields for initiatives.", "disabled": false }, { "key": "include", "value": "baseline_scenario%2Ctarget_scenario", "description": "Comma-separated relationships. Allowed: baseline_scenario,target_scenario.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/initiatives\/:id?fields%5Binitiatives%5D=id%2Ctitle&include=baseline_scenario%2Ctarget_scenario", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the initiative." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `initiatives.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"title\":\"Cost Reduction\",\"description\":\"Reduce infrastructure spend by 15%\",\"status\":\"active\",\"baseline_scenario\":{\"id\":1,\"name\":\"Current State\",\"status\":\"published\"},\"target_scenario\":{\"id\":2,\"name\":\"Optimized State\",\"status\":\"draft\"}}}", "name": "" } ] }, { "name": "Update a specific initiative.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/initiatives\/:id", "query": [ { "key": "fields%5Binitiatives%5D", "value": "id%2Ctitle", "description": "Sparse fields for initiatives.", "disabled": false }, { "key": "include", "value": "baseline_scenario%2Ctarget_scenario", "description": "Comma-separated relationships. Allowed: baseline_scenario,target_scenario.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/initiatives\/:id?fields%5Binitiatives%5D=id%2Ctitle&include=baseline_scenario%2Ctarget_scenario", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the initiative." } ] }, "method": "PUT", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Reduce Cloud Spend\",\"description\":\"Target a 15% reduction by Q4.\",\"status\":\"paused\",\"baseline_scenario_id\":1,\"target_scenario_id\":2}" }, "description": "Requires `initiatives.update` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"title\":\"Cost Optimization\",\"description\":\"Reduce infrastructure spend by 20%\",\"status\":\"active\",\"baseline_scenario_id\":1,\"target_scenario_id\":2}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"status\":[\"The selected status is invalid.\"]}}", "name": "" } ] }, { "name": "Delete a specific initiative.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/initiatives\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/initiatives\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the initiative." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `initiatives.delete` ability." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Integrations", "description": "", "item": [ { "name": "Receive BambooHR webhook payload.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integrations\/bamboohr\/webhook\/:tenant", "query": [], "raw": "{{baseUrl}}\/api\/v1\/integrations\/bamboohr\/webhook\/:tenant", "variable": [ { "id": "tenant", "key": "tenant", "value": "demo", "description": "Tenant slug." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint always responds quickly. When the tenant is missing, the plan\ndoes not include HRIS integrations, or webhook auth fails, it still returns\n`202 Accepted` without queueing sync work.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 202, "body": "{\"status\":\"accepted\"}", "name": "" } ] } ] }, { "name": "Lineage", "description": "", "item": [ { "name": "List baseline lineage events (promotions + snapshot restores).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/lineage", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Max 100.", "disabled": false }, { "key": "filter%5Btype%5D", "value": "scenario_promotion", "description": "Filter by lineage type (scenario_promotion, snapshot_restore).", "disabled": false }, { "key": "filter%5Bscenario_id%5D", "value": "42", "description": "Filter by related scenario id (promoted\/applied\/archived).", "disabled": false }, { "key": "filter%5Bapplied_from%5D", "value": "2025-01-01", "description": "date Filter by applied_at date (inclusive, YYYY-MM-DD).", "disabled": false }, { "key": "filter%5Bapplied_to%5D", "value": "2025-12-31", "description": "date Filter by applied_at date (inclusive, YYYY-MM-DD).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/lineage?page=1&per_page=25&filter%5Btype%5D=scenario_promotion&filter%5Bscenario_id%5D=42&filter%5Bapplied_from%5D=2025-01-01&filter%5Bapplied_to%5D=2025-12-31" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"page\":61,\"per_page\":7,\"filter\":{\"type\":\"snapshot_restore\",\"scenario_id\":11,\"applied_from\":\"2026-04-13T21:34:33\",\"applied_to\":\"2026-04-13T21:34:33\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"type\":\"scenario_promotion\",\"applied_at\":\"2026-01-30T12:00:00Z\"}],\"links\":{\"first\":null,\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"total\":1,\"current_page\":1,\"per_page\":15,\"last_page\":1}}", "name": "" } ] } ] }, { "name": "Org Placements", "description": "", "item": [ { "name": "Actor placements \u2014 List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:actor_id\/placements", "query": [ { "key": "as_of", "value": "2025-09-01", "description": "Filter placements active on this ISO 8601 date.", "disabled": false }, { "key": "include_history", "value": "1", "description": "Include historical placements in addition to the active set.", "disabled": false }, { "key": "scenario_id", "value": "future-plan", "description": "Scenario slug or id to scope placements; omit or pass `null` for baseline.", "disabled": false }, { "key": "include", "value": "actor%2Corg_unit", "description": "Comma-separated relationships. Allowed: actor,org_unit.", "disabled": false }, { "key": "fields%5Bplacements%5D", "value": "id%2Corg_unit_id%2Cvalid_from%2Cvalid_to", "description": "Sparse fieldset.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/actors\/:actor_id\/placements?as_of=2025-09-01&include_history=1&scenario_id=future-plan&include=actor%2Corg_unit&fields%5Bplacements%5D=id%2Corg_unit_id%2Cvalid_from%2Cvalid_to", "variable": [ { "id": "actor_id", "key": "actor_id", "value": "11", "description": "The ID of the actor." }, { "id": "actor", "key": "actor", "value": "11", "description": "The actor identifier." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return placements for an actor as of a date. By default only active placements\nare returned; pass `include_history=1` to include historical rows as well.\n\nRequires `placements.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"org_unit_id\":10,\"primary\":true,\"allocation_pct\":100,\"fte\":1,\"valid_from\":\"2025-01-01\",\"valid_to\":null,\"is_active\":true}]}", "name": "" } ] }, { "name": "Actor placements \u2014 Create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/actors\/:actor_id\/placements", "query": [ { "key": "include", "value": "org_unit", "description": "Comma-separated relationships. Allowed: actor,org_unit.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/actors\/:actor_id\/placements?include=org_unit", "variable": [ { "id": "actor_id", "key": "actor_id", "value": "11", "description": "The ID of the actor." }, { "id": "actor", "key": "actor", "value": "11", "description": "The actor identifier." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"org_unit_id\":10,\"scenario_id\":4,\"primary\":true,\"allocation_pct\":60,\"valid_from\":\"2025-09-01\",\"valid_to\":\"2025-12-31\",\"source\":\"manual\",\"meta\":[],\"fte\":0.6}" }, "description": "Creates a new placement for the given actor.\n\nRequires `placements.write` ability." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":9,\"org_unit_id\":10,\"primary\":false,\"allocation_pct\":60,\"fte\":0.6,\"valid_from\":\"2025-09-01\",\"valid_to\":null,\"is_active\":true}}", "name": "" } ] }, { "name": "Actor placements \u2014 Update", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/placements\/:id", "query": [ { "key": "include", "value": "actor", "description": "Comma-separated relationships. Allowed: actor,org_unit.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/placements\/:id?include=actor", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the placement." }, { "id": "placement", "key": "placement", "value": "11", "description": "Placement identifier." } ] }, "method": "PATCH", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"org_unit_id\":12,\"scenario_id\":4,\"primary\":false,\"allocation_pct\":50,\"valid_from\":\"2025-06-01\",\"valid_to\":\"2025-09-30\",\"source\":\"manual\",\"meta\":[],\"fte\":0.5}" }, "description": "Updates an existing placement.\n\nRequires `placements.write` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":9,\"org_unit_id\":12,\"allocation_pct\":50,\"fte\":0.5,\"valid_from\":\"2025-06-01\",\"valid_to\":\"2025-09-30\",\"is_active\":false}}", "name": "" } ] }, { "name": "Actor placements \u2014 End", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/placements\/:id", "query": [ { "key": "valid_to", "value": "2025-10-01", "description": "Date to end the placement on (YYYY-MM-DD). Defaults to today.", "disabled": false }, { "key": "include", "value": "org_unit", "description": "Comma-separated relationships. Allowed: actor,org_unit.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/placements\/:id?valid_to=2025-10-01&include=org_unit", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the placement." }, { "id": "placement", "key": "placement", "value": "11", "description": "Placement identifier." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Ends a placement by stamping the `valid_to` date. Omitting the\n`valid_to` query parameter defaults to today.\n\nRequires `placements.delete` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":9,\"valid_to\":\"2025-10-01\",\"is_active\":false}}", "name": "" } ] }, { "name": "Org unit roster \u2014 List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit_id\/actors", "query": [ { "key": "as_of", "value": "2025-09-01", "description": "Date used to evaluate active placements.", "disabled": false }, { "key": "scenario_id", "value": "future-plan", "description": "Scenario slug or id to scope placements; omit or pass `null` for baseline.", "disabled": false }, { "key": "include", "value": "actor", "description": "Comma-separated relationships. Allowed: actor,org_unit.", "disabled": false }, { "key": "fields%5Bplacements%5D", "value": "id%2Cactor_id%2Callocation_pct", "description": "Sparse fieldset.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit_id\/actors?as_of=2025-09-01&scenario_id=future-plan&include=actor&fields%5Bplacements%5D=id%2Cactor_id%2Callocation_pct", "variable": [ { "id": "org_unit_id", "key": "org_unit_id", "value": "11", "description": "The ID of the org unit." }, { "id": "org_unit", "key": "org_unit", "value": "11", "description": "The org unit identifier." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists active placements for the specified org unit. Results default to placements\nactive today but may be scoped to a different date using `as_of`.\n\nRequires `placements.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":7,\"actor\":{\"id\":14,\"name\":\"Aisling O'Neill\"},\"allocation_pct\":100,\"fte\":1,\"valid_from\":\"2025-07-01\",\"valid_to\":null,\"is_active\":true}]}", "name": "" } ] } ] }, { "name": "Org Units", "description": "", "item": [ { "name": "Display a paginated listing of org units.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Max 100.", "disabled": false }, { "key": "sort", "value": "-created_at%2Clabel", "description": "Comma-separated columns, prefix with - for DESC. Allowed: id,label,created_at.", "disabled": false }, { "key": "filter%5Btype%5D", "value": "node", "description": "Filter by the org unit type (string). Typical values include node, team, and department. Other values may appear if inserted in data.", "disabled": false }, { "key": "filter%5Bscenario_id%5D", "value": "1", "description": "Filter by scenario ID.", "disabled": false }, { "key": "filter%5Bparent_id%5D", "value": "42", "description": "Filter by parent org unit ID.", "disabled": false }, { "key": "fields%5Borg_units%5D", "value": "id%2Clabel", "description": "Sparse fields for org units.", "disabled": false }, { "key": "include", "value": "scenario%2Cactors%2Cmetrics", "description": "Comma-separated relationships. Allowed: scenario,actors,metrics.", "disabled": false }, { "key": "as_of", "value": "2025-09-01", "description": "date Filter actors memberships or metrics by date. Format: YYYY-MM-DD.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units?page=1&per_page=25&sort=-created_at%2Clabel&filter%5Btype%5D=node&filter%5Bscenario_id%5D=1&filter%5Bparent_id%5D=42&fields%5Borg_units%5D=id%2Clabel&include=scenario%2Cactors%2Cmetrics&as_of=2025-09-01" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":202,\"type\":\"node\",\"entity_id\":4102,\"label\":\"Retail \u2013 Ireland\",\"scenario_id\":1,\"parent_id\":101}],\"links\":{\"first\":null,\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"total\":1,\"current_page\":1,\"per_page\":15,\"last_page\":1}}", "name": "" }, { "header": [], "code": 400, "body": "{\"code\":\"query.invalid_parameter\",\"message\":\"Unsupported sort: salary\",\"details\":{\"allowed\":[\"id\",\"label\",\"created_at\"]}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"per_page\":[\"The per page must be at least 1.\"]}}", "name": "" } ] }, { "name": "Get a summarized charts view.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/summary", "query": [ { "key": "root_id", "value": "202", "description": "The ID of the root org unit.", "disabled": false }, { "key": "as_of", "value": "2025-09-01", "description": "date Format YYYY-MM-DD.", "disabled": false }, { "key": "sprint_id", "value": "42", "description": "The sprint for velocity metrics.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/summary?root_id=202&as_of=2025-09-01&sprint_id=42" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":202,\"label\":\"Retail \u2013 Ireland\",\"type\":\"node\",\"entity_id\":4102,\"rollup\":{\"direct_headcount\":12,\"subtree_headcount\":38,\"direct_monthly_cost_cents\":528500,\"subtree_monthly_cost_cents\":1285000,\"velocity_sp\":35,\"velocity_team_count\":3},\"children\":[]}}", "name": "" } ] }, { "name": "Get an org subtree (nested) for the current tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/tree", "query": [ { "key": "root_id", "value": "1", "description": "Optional root node id.", "disabled": false }, { "key": "depth", "value": "3", "description": "The max depth to traverse from the root. Default: 2.", "disabled": false }, { "key": "include", "value": "actors%2Cparent", "description": "Comma-separated includes: actors,members,parent,ancestors,path,metrics.", "disabled": false }, { "key": "filter[]", "value": "", "description": "", "disabled": true }, { "key": "filter.type", "value": "team", "description": "Filter by org unit type.", "disabled": false }, { "key": "search", "value": "Apollo", "description": "Case-insensitive search on label.", "disabled": false }, { "key": "sort", "value": "-label", "description": "Sort by label asc\/desc. Allowed: label, -label. Default: label.", "disabled": false }, { "key": "filter%5Btype%5D", "value": "team", "description": "Filter by org unit type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/tree?root_id=1&depth=3&include=actors%2Cparent&filter[]=&filter.type=team&search=Apollo&sort=-label&filter%5Btype%5D=team" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required The tenant slug or id." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the subtree for the given root_id (or the tenant root if omitted),\nup to a maximum depth. Supports includes (members,parent,ancestors,path,metrics),\nsearch by name, and filtering by type." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 101,\n \"label\": \"Engineering\",\n \"code\": null,\n \"type\": \"node\",\n \"entity_id\": 4102,\n \"parent_id\": null,\n \"scenario_id\": 1,\n \"valid_from\": null,\n \"valid_to\": null,\n \"created_at\": \"2025-01-10T09:00:00Z\",\n \"parent\": null,\n \"ancestors\": [],\n \"path\": [\"Engineering\"],\n \"metrics\": {\n \"as_of\": \"2025-01-10\",\n \"direct_headcount\": 0,\n \"subtree_headcount\": 0,\n \"direct_monthly_cost\": {\"value\": 0, \"formatted\": \"\u20ac0.00\", \"currency\": \"EUR\"},\n \"subtree_monthly_cost\": {\"value\": 0, \"formatted\": \"\u20ac0.00\", \"currency\": \"EUR\"}\n },\n \"children\": [\n {\n \"id\": 202,\n \"label\": \"Team C\u00faChulainn\",\n \"code\": null,\n \"type\": \"team\",\n \"entity_id\": 15,\n \"parent_id\": 101,\n \"scenario_id\": 1,\n \"valid_from\": null,\n \"valid_to\": null,\n \"created_at\": \"2025-01-10T09:00:00Z\",\n \"parent\": {\"id\":101,\"label\":\"Engineering\"},\n \"ancestors\": [{\"id\":101,\"label\":\"Engineering\"}],\n \"path\": [\"Engineering\",\"Team C\u00faChulainn\"],\n \"metrics\": {\n \"as_of\": \"2025-01-10\",\n \"direct_headcount\": 0,\n \"subtree_headcount\": 0,\n \"direct_monthly_cost\": {\"value\": 0, \"formatted\": \"\u20ac0.00\", \"currency\": \"EUR\"},\n \"subtree_monthly_cost\": {\"value\": 0, \"formatted\": \"\u20ac0.00\", \"currency\": \"EUR\"}\n },\n \"children\": []\n }\n ]\n }\n}", "name": "" } ] }, { "name": "Get flattened descendants with cursor pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:id\/descendants", "query": [ { "key": "depth", "value": "2", "description": "The max depth to traverse from the root. Default: 3.", "disabled": false }, { "key": "include", "value": "parent", "description": "Comma-separated includes: actors,members,parent,ancestors,path,metrics.", "disabled": false }, { "key": "filter[]", "value": "", "description": "", "disabled": true }, { "key": "filter.type", "value": "team", "description": "Filter by org unit type.", "disabled": false }, { "key": "search", "value": "Apollo", "description": "Case-insensitive search on label.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Items per page. Max 200.", "disabled": false }, { "key": "cursor", "value": "ab", "description": "Pagination cursor", "disabled": false }, { "key": "filter%5Btype%5D", "value": "team", "description": "Filter by org unit type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:id\/descendants?depth=2&include=parent&filter[]=&filter.type=team&search=Apollo&per_page=50&cursor=ab&filter%5Btype%5D=team", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The root id." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required The tenant slug or id." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 202,\n \"label\": \"Team C\u00faChulainn\",\n \"code\": null,\n \"type\": \"team\",\n \"entity_id\": 15,\n \"parent_id\": 101,\n \"scenario_id\": 1,\n \"valid_from\": null,\n \"valid_to\": null,\n \"created_at\": \"2025-01-10T09:00:00Z\",\n \"metrics\": {\n \"as_of\": \"2025-01-10\",\n \"direct_headcount\": 0,\n \"subtree_headcount\": 0,\n \"direct_monthly_cost\": {\"value\": 0, \"formatted\": \"\u20ac0.00\", \"currency\": \"EUR\"},\n \"subtree_monthly_cost\": {\"value\": 0, \"formatted\": \"\u20ac0.00\", \"currency\": \"EUR\"}\n }\n },\n {\n \"id\": 203,\n \"label\": \"Team Fianna\",\n \"code\": null,\n \"type\": \"team\",\n \"entity_id\": 16,\n \"parent_id\": 101,\n \"scenario_id\": 1,\n \"valid_from\": null,\n \"valid_to\": null,\n \"created_at\": \"2025-01-10T09:00:00Z\"\n }\n ],\n \"links\": {\"next\": null, \"prev\": null},\n \"meta\": {\"per_page\": 50}\n}", "name": "" } ] }, { "name": "Show a single org unit summary.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit", "query": [ { "key": "as_of", "value": "2025-09-01", "description": "date Format YYYY-MM-DD.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit?as_of=2025-09-01", "variable": [ { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The ID of the org unit." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":202,\"label\":\"Retail \u2013 Ireland\",\"type\":\"node\",\"entity_id\":4102,\"rollup\":{\"direct_headcount\":12,\"subtree_headcount\":38,\"direct_monthly_cost_cents\":528500,\"subtree_monthly_cost_cents\":1285000,\"velocity_sp\":35,\"velocity_team_count\":3},\"children\":[]}}", "name": "" } ] }, { "name": "List an org unit's immediate children.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit\/children", "query": [ { "key": "as_of", "value": "2025-09-01", "description": "date Format YYYY-MM-DD.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit\/children?as_of=2025-09-01", "variable": [ { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The ID of the org unit." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":210,\"label\":\"Team C\u00faChulainn\",\"type\":\"team\",\"entity_id\":15,\"rollup\":{\"direct_headcount\":8,\"subtree_headcount\":8,\"direct_monthly_cost_cents\":428500,\"subtree_monthly_cost_cents\":428500,\"velocity_sp\":18,\"velocity_team_count\":1},\"children\":[]}]}", "name": "" } ] }, { "name": "Create a new org unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org-units" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"team\",\"entity_id\":15,\"label\":\"Team C\u00faChulainn\",\"scenario_id\":1,\"parent_id\":202,\"valid_from\":\"2025-01-01\",\"valid_to\":\"2025-12-31\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":210,\"type\":\"team\",\"entity_id\":15,\"label\":\"Team C\u00faChulainn\",\"scenario_id\":1,\"parent_id\":202,\"valid_from\":\"2025-01-01\",\"valid_to\":\"2025-12-31\"}}", "name": "" } ] }, { "name": "Update an org unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit", "variable": [ { "id": "org_unit", "key": "org_unit", "value": "210", "description": "The ID of the org unit." } ] }, "method": "PATCH", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"team\",\"entity_id\":15,\"label\":\"Team C\u00faChulainn\",\"scenario_id\":1,\"parent_id\":202,\"valid_from\":\"2025-01-01\",\"valid_to\":\"2025-12-31\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":210,\"type\":\"team\",\"entity_id\":15,\"label\":\"Team C\u00faChulainn\",\"scenario_id\":1,\"parent_id\":202,\"valid_from\":\"2025-01-01\",\"valid_to\":\"2025-12-31\"}}", "name": "" } ] } ] }, { "name": "Org Units \u2014 Metrics", "description": "", "item": [ { "name": "Show the cached aggregate metrics for a single org unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit\/metrics", "query": [ { "key": "as_of", "value": "2025-09-01", "description": "date The date to compute metrics as of.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit\/metrics?as_of=2025-09-01", "variable": [ { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The org unit id." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"as_of\":\"2025-09-01\",\"direct_headcount\":8,\"subtree_headcount\":37,\"direct_monthly_cost_cents\":1250000,\"subtree_monthly_cost_cents\":4185000,\"metrics\":{\"span_of_control\":2}}}", "name": "" } ] } ] }, { "name": "Org Units \u2014 Structure", "description": "", "item": [ { "name": "Move an org unit to a new parent.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit_id\/move", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit_id\/move", "variable": [ { "id": "org_unit_id", "key": "org_unit_id", "value": "11", "description": "The ID of the org unit." }, { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The org unit id being moved." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required The tenant slug." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"target_parent_id\":11,\"position\":11,\"expected_updated_at\":\"ab\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":202,\"label\":\"Retail \u2013 Ireland\",\"code\":null,\"type\":\"node\",\"entity_id\":4102,\"parent_id\":88,\"scenario_id\":1,\"valid_from\":\"2025-01-01\",\"valid_to\":null,\"created_at\":\"2025-08-20T10:00:00Z\"}}", "name": "" } ] }, { "name": "Merge two org units.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/merge", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org-units\/merge" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required The tenant slug." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"source_id\":11,\"target_id\":11,\"strategy\":\"ab\",\"expected_updated_at_source\":\"2025-08-29T10:00:00Z\",\"expected_updated_at_target\":\"2025-08-29T10:00:00Z\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":202,\"label\":\"Retail \u2013 Ireland\",\"code\":null,\"type\":\"node\",\"entity_id\":4102,\"parent_id\":101,\"scenario_id\":1,\"valid_from\":\"2025-01-01\",\"valid_to\":null,\"created_at\":\"2025-08-20T10:00:00Z\"}}", "name": "" } ] }, { "name": "Split an org unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit_id\/split", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit_id\/split", "variable": [ { "id": "org_unit_id", "key": "org_unit_id", "value": "11", "description": "The ID of the org unit." }, { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The org unit id being split." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required The tenant slug." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mode\":\"ab\",\"label\":\"ab\",\"children_to_move\":[\"ab\"],\"expected_updated_at\":\"ab\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"original\":{\"id\":202,\"label\":\"Retail \u2013 Ireland\",\"code\":null,\"type\":\"node\",\"entity_id\":4102,\"parent_id\":101,\"scenario_id\":1,\"valid_from\":\"2025-01-01\",\"valid_to\":null,\"created_at\":\"2025-08-20T10:00:00Z\"},\"created\":{\"id\":244,\"label\":\"Payments \u2013 Ops\",\"code\":null,\"type\":\"node\",\"entity_id\":4102,\"parent_id\":101,\"scenario_id\":1,\"valid_from\":\"2025-01-01\",\"valid_to\":null,\"created_at\":\"2026-03-07T10:30:00Z\"}}}", "name": "" } ] }, { "name": "Soft delete an org unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit_id", "variable": [ { "id": "org_unit_id", "key": "org_unit_id", "value": "11", "description": "The ID of the org unit." }, { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The org unit id being deleted." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required The tenant slug." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"target_parent_id\":101,\"position\":2,\"expected_updated_at\":\"ab\"}" }, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Restore an org unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit_id\/restore", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit_id\/restore", "variable": [ { "id": "org_unit_id", "key": "org_unit_id", "value": "11", "description": "The ID of the org unit." }, { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The soft-deleted org unit id." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required The tenant slug." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":202,\"label\":\"Retail \u2013 Ireland\",\"code\":null,\"type\":\"node\",\"entity_id\":4102,\"parent_id\":101,\"scenario_id\":1,\"valid_from\":\"2025-01-01\",\"valid_to\":null,\"created_at\":\"2025-08-20T10:00:00Z\"}}", "name": "" } ] } ] }, { "name": "Org Units \u2014 Velocity", "description": "", "item": [ { "name": "Get velocity for an org unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit\/velocity", "query": [ { "key": "sprint_id", "value": "11", "description": "The sprint to query.", "disabled": false }, { "key": "as_of", "value": "ab", "description": "date Mutually exclusive with sprint_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit\/velocity?sprint_id=11&as_of=ab", "variable": [ { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The org unit ID." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"org_unit_id\":202,\"sprint_id\":42,\"period\":{\"label\":\"Sprint 18\",\"starts_at\":\"2025-09-01\",\"ends_at\":\"2025-09-14\"},\"velocity_sp\":88,\"teams_count\":4}}", "name": "" } ] }, { "name": "Get velocity series for an org unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-units\/:org_unit\/velocity\/series", "query": [ { "key": "from_sprint_id", "value": "1", "description": "Starting sprint ID. The id of an existing record in the sprint_periods table.", "disabled": false }, { "key": "to_sprint_id", "value": "10", "description": "Ending sprint ID. The id of an existing record in the sprint_periods table.", "disabled": false }, { "key": "from", "value": "2025-01-01", "description": "Start date (YYYY-MM-DD). Must be a valid date. Must be a valid date in the format Y-m-d.", "disabled": false }, { "key": "to", "value": "2025-06-01", "description": "End date (YYYY-MM-DD). Must be a valid date. Must be a valid date in the format Y-m-d.", "disabled": false }, { "key": "limit", "value": "12", "description": "Maximum number of sprints to return. Must be at least 1. Must not be greater than 50.", "disabled": false }, { "key": "order", "value": "asc", "description": "Sort order by sprint start.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-units\/:org_unit\/velocity\/series?from_sprint_id=1&to_sprint_id=10&from=2025-01-01&to=2025-06-01&limit=12&order=asc", "variable": [ { "id": "org_unit", "key": "org_unit", "value": "202", "description": "The org unit ID." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"org_unit_id\":202,\"sprint_id\":41,\"period\":{\"label\":\"Sprint 17\",\"starts_at\":\"2025-08-18\",\"ends_at\":\"2025-08-31\"},\"velocity_sp\":81,\"teams_count\":4},{\"org_unit_id\":202,\"sprint_id\":42,\"period\":{\"label\":\"Sprint 18\",\"starts_at\":\"2025-09-01\",\"ends_at\":\"2025-09-14\"},\"velocity_sp\":88,\"teams_count\":4}]}", "name": "" } ] } ] }, { "name": "Organisation Accounts", "description": "\nAPI descriptions intentionally use \u201cOrganisation Account\u201d wording for user-facing clarity.", "item": [ { "name": "List Organisation Accounts available to the authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me\/organisations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/me\/organisations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the Organisation Accounts that the authenticated user can access." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 12,\n \"name\": \"Acme Product\",\n \"slug\": \"acme-product\",\n \"plan_code\": \"team\",\n \"subscription_status\": \"trialing\",\n \"trial_ends_at\": \"2026-03-06T12:00:00Z\",\n \"onboarding_completed_at\": null,\n \"role\": \"owner\"\n }\n ]\n}", "name": "" } ] }, { "name": "Get the current Organisation Account details.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organisations\/current", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organisations\/current" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Resolution follows the standard precedence (subdomain, last-used Organisation, session fallback)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 12,\n \"name\": \"Acme Product\",\n \"slug\": \"acme-product\",\n \"plan_code\": \"team\",\n \"onboarding_choice\": \"import\",\n \"onboarding_completed_at\": null,\n \"trial_started_at\": \"2026-02-21T12:00:00Z\",\n \"trial_ends_at\": \"2026-03-06T12:00:00Z\",\n \"subscription_status\": \"trialing\",\n \"grace_ends_at\": null,\n \"locked_at\": null,\n \"role\": \"owner\",\n \"saml_enabled\": false,\n \"current_token\": {\n \"abilities\": [\"cli.access\", \"actors.read\", \"scenarios.read\"],\n \"cli_access\": true\n }\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\"code\":\"tenant.not_resolved\",\"message\":\"No Organisation Account is currently selected.\"}", "name": "" } ] }, { "name": "Update onboarding choice for the current Organisation Account.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organisations\/current\/onboarding-choice", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organisations\/current\/onboarding-choice" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"onboarding_choice\":\"import\"}" }, "description": "Persists how this Organisation Account will start onboarding." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 12,\n \"name\": \"Acme Product\",\n \"slug\": \"acme-product\",\n \"onboarding_choice\": \"import\",\n \"subscription_status\": \"trialing\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\"code\":\"tenant.not_resolved\",\"message\":\"No Organisation Account is currently selected.\"}", "name": "" } ] } ] }, { "name": "Positions", "description": "Manage effective-dated team positions, linking actors, teams, and compensation within each scenario.", "item": [ { "name": "List positions with pagination, filters, and search.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/positions", "query": [ { "key": "page", "value": "1", "description": "The page number to return.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page (max 100).", "disabled": false }, { "key": "sort", "value": "-valid_from", "description": "Comma-separated columns, prefix with - for DESC. Allowed: id,valid_from,valid_to,fte,created_at.", "disabled": false }, { "key": "filter%5Borg_unit_team_id%5D", "value": "4201", "description": "Filter by a budgeted team org unit (planning metadata only).", "disabled": false }, { "key": "filter%5Btarget_employment_type%5D", "value": "perm", "description": "Restrict by budgeted employment type (perm or contractor).", "disabled": false }, { "key": "filter%5Bactive_as_of%5D", "value": "2025-09-20", "description": "date Return positions active on this ISO date (YYYY-MM-DD).", "disabled": false }, { "key": "filter%5Bscenario%5D", "value": "current", "description": "Scenario shorthand: baseline, current, or an id.", "disabled": false }, { "key": "filter%5Bscenario_id%5D", "value": "7", "description": "Scenario identifier; overrides shorthand when present.", "disabled": false }, { "key": "q", "value": "platform+engineer", "description": "Free-text search across title, team name, and actor name.", "disabled": false }, { "key": "include", "value": "team%2Cactor", "description": "Comma-separated relationships. Allowed: team,actor.", "disabled": false }, { "key": "fields%5Bpositions%5D", "value": "id%2Ctitle%2Cteam", "description": "Sparse fieldset selection.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/positions?page=1&per_page=25&sort=-valid_from&filter%5Borg_unit_team_id%5D=4201&filter%5Btarget_employment_type%5D=perm&filter%5Bactive_as_of%5D=2025-09-20&filter%5Bscenario%5D=current&filter%5Bscenario_id%5D=7&q=platform+engineer&include=team%2Cactor&fields%5Bpositions%5D=id%2Ctitle%2Cteam" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns baseline data when no scenario filter is supplied; pass\n`filter[scenario]=current` to reflect the active scenario." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 17,\n \"org_unit_team_id\": 4201, \/\/ planning metadata only\n \"title\": \"Staff Platform Engineer\",\n \"target_employment_type\": \"perm\",\n \"fte\": 1,\n \"target_annual_salary_cents\": 11850000,\n \"target_daily_rate_cents\": null,\n \"target_currency\": \"EUR\",\n \"valid_from\": \"2024-03-01\",\n \"valid_to\": null,\n \"scenario_id\": null,\n \"meta\": {\n \"cost_centre\": \"ENG-PLAT\",\n \"notes\": \"Supports platform migration.\"\n },\n \"team\": {\n \"id\": 8,\n \"name\": \"Platform Experience\",\n \"slug\": \"platform-experience\"\n },\n \"actor\": null,\n \"links\": {\n \"self\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/positions\/17\",\n \"team\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/teams\/8\",\n \"actor\": null\n },\n \"created_at\": \"2025-09-19T09:00:00Z\",\n \"updated_at\": \"2025-09-19T09:00:00Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/positions?page=1\",\n \"last\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/positions?page=3\",\n \"prev\": null,\n \"next\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/positions?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 3,\n \"path\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/positions\",\n \"per_page\": 25,\n \"to\": 25,\n \"total\": 62\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"code\": \"query.invalid_parameter\",\n \"message\": \"Unsupported scenario filter value: future\",\n \"details\": {\n \"allowed\": [\"baseline\", \"current\", \"{id}\"]\n }\n}", "name": "" } ] }, { "name": "Create a position within the active scenario.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/positions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/positions" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"ab\",\"role_type_id\":11,\"org_unit_team_id\":4201,\"target_employment_type\":\"ab\",\"fte\":1,\"target_annual_salary_cents\":8500000,\"target_daily_rate_cents\":45000,\"target_currency\":\"EUR\",\"valid_from\":\"2025-09-20\",\"valid_to\":\"2026-03-31\",\"meta\":{\"cost_centre\":\"ENG-PLAT\"},\"create_placement\":true,\"tenant_id\":11,\"scenario_id\":11}" }, "description": "Applies baseline defaults when the current scenario guard is baseline,\notherwise stores the record against the active scenario id." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 24,\n \"org_unit_team_id\": 4201, \/\/ planning metadata only\n \"title\": \"Staff Platform Engineer\",\n \"target_employment_type\": \"perm\",\n \"fte\": 1,\n \"target_annual_salary_cents\": 11850000,\n \"target_daily_rate_cents\": null,\n \"target_currency\": \"EUR\",\n \"valid_from\": \"2024-03-01\",\n \"valid_to\": null,\n \"scenario_id\": null,\n \"meta\": {\n \"cost_centre\": \"ENG-PLAT\",\n \"notes\": \"Supports platform migration.\"\n },\n \"team\": {\n \"id\": 8,\n \"name\": \"Platform Experience\",\n \"slug\": \"platform-experience\"\n },\n \"actor\": null,\n \"links\": {\n \"self\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/positions\/24\",\n \"team\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/teams\/8\",\n \"actor\": null\n },\n \"created_at\": \"2025-09-19T09:15:00Z\",\n \"updated_at\": \"2025-09-19T09:15:00Z\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"target_annual_salary_cents\": [\n \"Budgeted annual salary applies to permanent roles only.\"\n ]\n }\n}", "name": "" } ] }, { "name": "Display a specific position.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/positions\/:id", "query": [ { "key": "include", "value": "team", "description": "Comma-separated relationships. Allowed: team,actor.", "disabled": false }, { "key": "fields%5Bpositions%5D", "value": "id%2Ctitle%2Cteam", "description": "Sparse fieldset.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/positions\/:id?include=team&fields%5Bpositions%5D=id%2Ctitle%2Cteam", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the position." }, { "id": "position", "key": "position", "value": "24", "description": "The ID of the position." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Honors the active scenario guard unless `filter[scenario]`\/`filter[scenario_id]`\nwere provided on the index request and cached via query options middleware." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 24,\n \"org_unit_team_id\": 4201, \/\/ planning metadata only\n \"actor_id\": null,\n \"title\": \"Staff Platform Engineer\",\n \"target_employment_type\": \"perm\",\n \"fte\": 1,\n \"target_annual_salary_cents\": 11850000,\n \"target_daily_rate_cents\": null,\n \"target_currency\": \"EUR\",\n \"valid_from\": \"2024-03-01\",\n \"valid_to\": null,\n \"scenario_id\": null,\n \"meta\": {\n \"cost_centre\": \"ENG-PLAT\",\n \"notes\": \"Supports platform migration.\"\n },\n \"team\": {\n \"id\": 8,\n \"name\": \"Platform Experience\",\n \"slug\": \"platform-experience\"\n },\n \"actor\": null,\n \"links\": {\n \"self\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/positions\/24\",\n \"team\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/teams\/8\",\n \"actor\": null\n },\n \"created_at\": \"2025-09-19T09:15:00Z\",\n \"updated_at\": \"2025-09-19T09:15:00Z\"\n }\n}", "name": "" } ] }, { "name": "Update a position.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/positions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/positions\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the position." } ] }, "method": "PUT", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"ab\",\"role_type_id\":11,\"org_unit_team_id\":4201,\"target_employment_type\":\"ab\",\"fte\":1,\"target_annual_salary_cents\":8500000,\"target_daily_rate_cents\":45000,\"target_currency\":\"EUR\",\"valid_from\":\"2025-09-20\",\"valid_to\":\"2026-03-31\",\"meta\":{\"cost_centre\":\"ENG-PLAT\"},\"create_placement\":true,\"tenant_id\":11,\"scenario_id\":11}" }, "description": "Validation enforces mutual exclusivity between salary and daily rate,\nmirroring the create endpoint rules." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 24,\n \"org_unit_team_id\": 4201, \/\/ planning metadata only\n \"actor_id\": null,\n \"title\": \"Principal Platform Engineer\",\n \"target_employment_type\": \"perm\",\n \"fte\": 1,\n \"target_annual_salary_cents\": 12600000,\n \"target_daily_rate_cents\": null,\n \"target_currency\": \"EUR\",\n \"valid_from\": \"2024-03-01\",\n \"valid_to\": null,\n \"scenario_id\": null,\n \"meta\": {\n \"cost_centre\": \"ENG-PLAT\",\n \"notes\": \"Role upgraded to lead migration.\"\n },\n \"team\": {\n \"id\": 8,\n \"name\": \"Platform Experience\",\n \"slug\": \"platform-experience\"\n },\n \"actor\": null,\n \"links\": {\n \"self\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/positions\/24\",\n \"team\": \"https:\/\/tenant.orgonaut.test\/api\/v1\/teams\/8\",\n \"actor\": null\n },\n \"created_at\": \"2025-09-19T09:15:00Z\",\n \"updated_at\": \"2025-09-26T11:20:00Z\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"target_daily_rate_cents\": [\n \"Budgeted daily rate applies to contractor roles only.\"\n ]\n }\n}", "name": "" } ] }, { "name": "Soft delete a position.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/positions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/positions\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the position." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Scenario Tasks", "description": "", "item": [ { "name": "List scenario tasks.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/scenarios\/tasks", "query": [ { "key": "status", "value": "running", "description": "Filter by status (pending, running, failed, complete).", "disabled": false }, { "key": "type", "value": "promotion", "description": "Filter by task type (clone, promotion, snapshot, all). Defaults to clone for compatibility.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/scenarios\/tasks?status=running&type=promotion" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns scenario tasks for the authenticated tenant, ordered by latest first.\nThese tasks mirror the progress shown in the Flux UI at \/scenarios\/tasks." }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 81,\n \"scenario_id\": 42,\n \"scenario_name\": \"Q2 Planning\",\n \"type\": \"clone\",\n \"stage\": \"actors\",\n \"status\": \"running\",\n \"percent\": 33,\n \"message\": \"Copying Actors...\",\n \"error_message\": null,\n \"created_at\": \"2025-11-01T12:14:22Z\",\n \"updated_at\": \"2025-11-01T12:15:03Z\"\n }\n]", "name": "" } ] } ] }, { "name": "Scenarios", "description": "", "item": [ { "name": "Display a paginated listing of scenarios.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/scenarios", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Max 100.", "disabled": false }, { "key": "sort", "value": "-created_at%2Cname", "description": "Comma-separated columns, prefix with - for DESC. Allowed: id,name,created_at.", "disabled": false }, { "key": "filter%5Bstatus%5D", "value": "cloning", "description": "Filter by status.", "disabled": false }, { "key": "filter%5Bkind%5D", "value": "planning", "description": "Filter by kind (planning, baseline_archive, applied_scenario).", "disabled": false }, { "key": "fields%5Bscenarios%5D", "value": "id%2Cname%2Cstatus", "description": "Sparse fields for scenarios.", "disabled": false }, { "key": "include", "value": "teams%2Caggregate", "description": "Comma-separated relationships. Allowed: teams,aggregate.", "disabled": false }, { "key": "as_of", "value": "2025-09-01", "description": "Snapshot date for aggregates. Format: YYYY-MM-DD.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/scenarios?page=1&per_page=25&sort=-created_at%2Cname&filter%5Bstatus%5D=cloning&filter%5Bkind%5D=planning&fields%5Bscenarios%5D=id%2Cname%2Cstatus&include=teams%2Caggregate&as_of=2025-09-01" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"name\":\"FY26 Cost Optimisation\",\"status\":\"new\"}],\"links\":{\"first\":null,\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"total\":1,\"current_page\":1,\"per_page\":15,\"last_page\":1}}", "name": "" }, { "header": [], "code": 400, "body": "{\"code\":\"query.invalid_parameter\",\"message\":\"Unsupported sort: salary\",\"details\":{\"allowed\":[\"id\",\"name\",\"created_at\"]}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"per_page\":[\"The per page must be at least 1.\"]}}", "name": "" } ] }, { "name": "Create a new scenario.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/scenarios", "query": [], "raw": "{{baseUrl}}\/api\/v1\/scenarios" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\\\"Q2 Planning\\\"\",\"notes\":\"\\\"Budget-cut planning run.\\\"\",\"source_scenario_id\":12}" }, "description": "Triggers a background clone pipeline and returns immediately with status=initialising." }, "response": [ { "header": [], "code": 202, "body": "{\n \"message\": \"Scenario creation started. Cloning in progress.\",\n \"status\": \"initialising\",\n \"scenario\": {\n \"id\": 42,\n \"name\": \"Q2 Planning\",\n \"status\": \"initialising\",\n \"notes\": \"Budget-cut planning run.\"\n },\n \"tasks_url\": \"https:\/\/app.orgonaut.test\/api\/v1\/scenarios\/tasks\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\"code\":\"feature.unavailable\",\"message\":\"Your current subscription plan does not include this feature.\"}", "name": "" }, { "header": [], "code": 429, "body": "{\"code\":\"limit.scenarios\",\"message\":\"Active planning scenario limit reached (1\/1). Archive or apply an existing scenario, or upgrade your plan.\",\"limit\":1,\"current\":1}", "name": "" } ] }, { "name": "Display the specified scenario.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/scenarios\/:slug", "query": [ { "key": "include", "value": "aggregate", "description": "Comma-separated relationships. Allowed: teams,aggregate.", "disabled": false }, { "key": "as_of", "value": "2025-09-01", "description": "Snapshot date for aggregates. Format: YYYY-MM-DD.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/scenarios\/:slug?include=aggregate&as_of=2025-09-01", "variable": [ { "id": "slug", "key": "slug", "value": "ab", "description": "The slug of the scenario." }, { "id": "scenario", "key": "scenario", "value": "1", "description": "The ID of the scenario." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"FY26 Cost Optimisation\",\"status\":\"new\",\"aggregate\":{\"as_of_date\":\"2025-09-01\",\"scenario_direct_headcount\":0,\"scenario_subtree_headcount\":0,\"scenario_direct_monthly_cost_cents\":0,\"scenario_subtree_monthly_cost_cents\":0,\"velocity_completed_sp\":0,\"velocity_team_count\":0,\"computed_at\":\"2025-09-06T12:00:00Z\",\"metrics\":{}}}}", "name": "" } ] }, { "name": "Show computed deltas between a scenario and its source baseline.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/scenarios\/:scenario_slug\/delta", "query": [], "raw": "{{baseUrl}}\/api\/v1\/scenarios\/:scenario_slug\/delta", "variable": [ { "id": "scenario_slug", "key": "scenario_slug", "value": "ab", "description": "The slug of the scenario." }, { "id": "scenario", "key": "scenario", "value": "7", "description": "Scenario id." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"scenario\":{\"id\":7,\"name\":\"FY26 Restructure\",\"slug\":\"fy26-restructure\",\"status\":\"draft\",\"kind\":\"planning\",\"notes\":\"Budget-cut planning run.\",\"live_from\":null,\"live_to\":null,\"locked_at\":null,\"archived_at\":null,\"is_read_only\":false,\"source_scenario_id\":null,\"created_at\":\"2026-03-01T09:00:00Z\",\"updated_at\":\"2026-03-01T09:00:00Z\"},\"source\":{\"id\":1,\"name\":\"Current State\",\"slug\":\"current-state\",\"status\":\"published\",\"kind\":\"planning\",\"notes\":null,\"live_from\":null,\"live_to\":null,\"locked_at\":null,\"archived_at\":null,\"is_read_only\":false,\"source_scenario_id\":null,\"created_at\":\"2025-12-15T09:00:00Z\",\"updated_at\":\"2025-12-15T09:00:00Z\"},\"metrics\":{\"headcount\":{\"label\":\"Headcount\",\"scenario\":118,\"source\":123,\"delta\":-5},\"fte\":{\"label\":\"FTE\",\"scenario\":111.4,\"source\":116.4,\"delta\":-5},\"cost\":{\"label\":\"Monthly Cost (cents)\",\"scenario\":142500000,\"source\":148000000,\"delta\":-5500000},\"velocity\":{\"label\":\"Velocity (SP)\",\"scenario\":89,\"source\":95,\"delta\":-6}},\"teams\":[{\"key\":\"team:44\",\"status\":\"changed\",\"department\":\"Engineering\",\"placements\":[],\"badges\":[]}],\"actors\":[{\"key\":\"actor:98\",\"status\":\"changed\",\"badges\":[]}],\"change_log\":[{\"entity_type\":\"Team\",\"action\":\"updated\",\"classification\":\"updated\",\"identity\":{\"name\":\"Platform Enablement\"},\"created_at\":\"2026-03-01T10:15:00Z\",\"count\":1}]}", "name": "" } ] }, { "name": "Promote a planning scenario to the live baseline.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/scenarios\/:scenario_slug\/promote", "query": [], "raw": "{{baseUrl}}\/api\/v1\/scenarios\/:scenario_slug\/promote", "variable": [ { "id": "scenario_slug", "key": "scenario_slug", "value": "ab", "description": "The slug of the scenario." }, { "id": "scenario", "key": "scenario", "value": "1", "description": "The ID of the scenario." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"confirmed_promotion\":true,\"confirmed_archive\":true}" }, "description": "Queues the existing promotion pipeline with type `scenario_promotion`." }, "response": [ { "header": [], "code": 202, "body": "{\"message\":\"Scenario promotion started. Promotion in progress.\",\"status\":\"queued\",\"scenario_id\":1,\"tasks_url\":\"https:\/\/app.orgonaut.test\/api\/v1\/scenarios\/tasks\"}", "name": "" } ] }, { "name": "Submit the scenario for review.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/scenarios\/:scenario_slug\/submit", "query": [], "raw": "{{baseUrl}}\/api\/v1\/scenarios\/:scenario_slug\/submit", "variable": [ { "id": "scenario_slug", "key": "scenario_slug", "value": "ab", "description": "The slug of the scenario." }, { "id": "scenario", "key": "scenario", "value": "1", "description": "The ID of the scenario." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"FY26 Cost Optimisation\",\"status\":\"under_review\"}}", "name": "" } ] }, { "name": "Approve the scenario.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/scenarios\/:scenario_slug\/approve", "query": [], "raw": "{{baseUrl}}\/api\/v1\/scenarios\/:scenario_slug\/approve", "variable": [ { "id": "scenario_slug", "key": "scenario_slug", "value": "ab", "description": "The slug of the scenario." }, { "id": "scenario", "key": "scenario", "value": "1", "description": "The ID of the scenario." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"FY26 Cost Optimisation\",\"status\":\"approved\"}}", "name": "" } ] } ] }, { "name": "Snapshots", "description": "", "item": [ { "name": "List baseline snapshots.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/snapshots", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Max 100.", "disabled": false }, { "key": "sort", "value": "-created_at%2Cname", "description": "Comma-separated columns, prefix with - for DESC. Allowed: id,name,created_at.", "disabled": false }, { "key": "filter%5Bstatus%5D", "value": "archived", "description": "Filter by status.", "disabled": false }, { "key": "fields%5Bscenarios%5D", "value": "id%2Cname%2Ckind", "description": "Sparse fields for scenarios.", "disabled": false }, { "key": "include", "value": "aggregate", "description": "Comma-separated relationships. Allowed: teams,aggregate.", "disabled": false }, { "key": "as_of", "value": "2025-09-01", "description": "Snapshot date for aggregates. Format: YYYY-MM-DD.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/snapshots?page=1&per_page=25&sort=-created_at%2Cname&filter%5Bstatus%5D=archived&fields%5Bscenarios%5D=id%2Cname%2Ckind&include=aggregate&as_of=2025-09-01" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":12,\"name\":\"Baseline Snapshot 2025-11-01\",\"kind\":\"baseline_archive\"}],\"links\":{\"first\":null,\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"total\":1,\"current_page\":1,\"per_page\":15,\"last_page\":1}}", "name": "" } ] }, { "name": "Display a baseline snapshot.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/snapshots\/:scenario_slug", "query": [ { "key": "include", "value": "aggregate", "description": "Comma-separated relationships. Allowed: teams,aggregate.", "disabled": false }, { "key": "as_of", "value": "2025-09-01", "description": "Snapshot date for aggregates. Format: YYYY-MM-DD.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/snapshots\/:scenario_slug?include=aggregate&as_of=2025-09-01", "variable": [ { "id": "scenario_slug", "key": "scenario_slug", "value": "ab", "description": "The slug of the scenario." }, { "id": "scenario", "key": "scenario", "value": "12", "description": "Snapshot id." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":12,\"name\":\"Baseline Snapshot 2025-11-01\",\"kind\":\"baseline_archive\",\"status\":\"archived\"}}", "name": "" } ] }, { "name": "Restore a baseline snapshot to become the live baseline.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/snapshots\/:scenario_slug\/restore", "query": [], "raw": "{{baseUrl}}\/api\/v1\/snapshots\/:scenario_slug\/restore", "variable": [ { "id": "scenario_slug", "key": "scenario_slug", "value": "ab", "description": "The slug of the scenario." }, { "id": "scenario", "key": "scenario", "value": "12", "description": "Snapshot id." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"confirmed_promotion\":true,\"confirmed_archive\":true}" }, "description": "Queues the existing promotion pipeline with type `snapshot_restore`." }, "response": [ { "header": [], "code": 202, "body": "{\"message\":\"Snapshot restore started. Promotion in progress.\",\"status\":\"queued\",\"snapshot_id\":12,\"tasks_url\":\"https:\/\/app.orgonaut.test\/api\/v1\/scenarios\/tasks\"}", "name": "" } ] } ] }, { "name": "Teams", "description": "", "item": [ { "name": "Display a paginated listing of teams.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Max 100.", "disabled": false }, { "key": "sort", "value": "-created_at%2Cname", "description": "Comma-separated columns, prefix with - for DESC. Allowed: id,name,created_at.", "disabled": false }, { "key": "filter%5Bdepartment_id%5D", "value": "5", "description": "Filter by department id.", "disabled": false }, { "key": "filter%5Borg_unit_id%5D", "value": "10", "description": "Filter by org unit id (department subtree).", "disabled": false }, { "key": "fields%5Bteams%5D", "value": "id%2Cname", "description": "Sparse fields for teams.", "disabled": false }, { "key": "include", "value": "aggregate", "description": "Comma-separated relationships. Allowed: aggregate.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/teams?page=1&per_page=25&sort=-created_at%2Cname&filter%5Bdepartment_id%5D=5&filter%5Borg_unit_id%5D=10&fields%5Bteams%5D=id%2Cname&include=aggregate" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `teams.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":15,\"name\":\"Team C\u00faChulainn\"}],\"links\":{\"first\":null,\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"total\":1,\"current_page\":1,\"per_page\":15,\"last_page\":1}}", "name": "" }, { "header": [], "code": 400, "body": "{\"code\":\"query.invalid_parameter\",\"message\":\"Unsupported sort: salary\",\"details\":{\"allowed\":[\"id\",\"name\",\"created_at\"]}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"per_page\":[\"The per page must be at least 1.\"]}}", "name": "" } ] }, { "name": "Store a newly created team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Platform\",\"team_type_id\":1,\"purpose\":\"Internal platforms\",\"valid_from\":\"2025-01-01\",\"valid_to\":\"2025-12-31\",\"parent_org_unit_id\":7}" }, "description": "Requires `teams.create` ability." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":15,\"name\":\"Team C\u00faChulainn\",\"team_type_id\":3,\"team_type\":{\"id\":3,\"name\":\"Cross-functional\",\"slug\":\"cross-functional\"},\"purpose\":\"Platform delivery\",\"parent_org_unit_id\":202,\"scenario_id\":1}}", "name": "" } ] }, { "name": "Display a specific team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `teams.read` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":15,\"name\":\"Team C\u00faChulainn\",\"team_type_id\":3,\"team_type\":{\"id\":3,\"name\":\"Cross-functional\",\"slug\":\"cross-functional\"},\"purpose\":\"Platform delivery\",\"parent_org_unit_id\":202,\"scenario_id\":1,\"created_at\":\"2025-01-10T09:00:00Z\"}}", "name": "" } ] }, { "name": "Update a team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the team." } ] }, "method": "PUT", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Platform\",\"team_type_id\":1,\"purpose\":\"Internal platforms\",\"valid_from\":\"2025-01-01\",\"valid_to\":\"2025-12-31\",\"parent_org_unit_id\":7}" }, "description": "Requires `teams.update` ability." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":15,\"name\":\"Team Fianna\",\"team_type_id\":3,\"team_type\":{\"id\":3,\"name\":\"Cross-functional\",\"slug\":\"cross-functional\"},\"purpose\":\"Platform delivery\",\"parent_org_unit_id\":202,\"scenario_id\":1}}", "name": "" } ] }, { "name": "Delete a team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the team." } ] }, "method": "DELETE", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `teams.delete` ability." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Teams \u2014 Velocity", "description": "", "item": [ { "name": "Get velocity stats for a team in a sprint.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/velocity", "query": [ { "key": "sprint_id", "value": "11", "description": "The sprint to query.", "disabled": false }, { "key": "as_of", "value": "ab", "description": "date Mutually exclusive with sprint_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/velocity?sprint_id=11&as_of=ab", "variable": [ { "id": "team_id", "key": "team_id", "value": "11", "description": "The ID of the team." }, { "id": "team", "key": "team", "value": "12", "description": "The team ID." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"team_id\":12,\"sprint_id\":42,\"period\":{\"label\":\"Sprint 18\",\"starts_at\":\"2025-09-01\",\"ends_at\":\"2025-09-14\"},\"committed_sp\":34,\"completed_sp\":31,\"scope_added_sp\":3,\"carried_over_sp\":5,\"stories_done\":12,\"source\":\"jira\"}}", "name": "" } ] }, { "name": "Get a velocity series for a team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/velocity\/series", "query": [ { "key": "from_sprint_id", "value": "11", "description": "Starting sprint ID.", "disabled": false }, { "key": "to_sprint_id", "value": "11", "description": "Ending sprint ID.", "disabled": false }, { "key": "from", "value": "ab", "description": "date Start date.", "disabled": false }, { "key": "to", "value": "ab", "description": "date End date.", "disabled": false }, { "key": "limit", "value": "11", "description": "Maximum results. Defaults to 12.", "disabled": false }, { "key": "order", "value": "ab", "description": "asc or desc. Defaults to asc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/velocity\/series?from_sprint_id=11&to_sprint_id=11&from=ab&to=ab&limit=11&order=ab", "variable": [ { "id": "team_id", "key": "team_id", "value": "11", "description": "The ID of the team." }, { "id": "team", "key": "team", "value": "12", "description": "The team ID." } ] }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"demo\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"team_id\":12,\"sprint_id\":41,\"period\":{\"label\":\"Sprint 17\",\"starts_at\":\"2025-08-18\",\"ends_at\":\"2025-08-31\"},\"committed_sp\":29,\"completed_sp\":27,\"scope_added_sp\":2,\"carried_over_sp\":4,\"stories_done\":10,\"source\":\"jira\"},{\"team_id\":12,\"sprint_id\":42,\"period\":{\"label\":\"Sprint 18\",\"starts_at\":\"2025-09-01\",\"ends_at\":\"2025-09-14\"},\"committed_sp\":34,\"completed_sp\":31,\"scope_added_sp\":3,\"carried_over_sp\":5,\"stories_done\":12,\"source\":\"jira\"}]}", "name": "" } ] } ] }, { "name": "Tenant Invitations", "description": "", "item": [ { "name": "List invitations for the current tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-invitations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-invitations" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":17,\"tenant_id\":3,\"email\":\"new.user@example.com\",\"role\":\"manager\",\"state\":\"pending\",\"invited_by\":7,\"expires_at\":\"2026-03-14T09:00:00Z\",\"accepted_at\":null,\"accepted_by_user_id\":null,\"revoked_at\":null,\"created_at\":\"2026-03-07T09:00:00Z\",\"updated_at\":\"2026-03-07T09:00:00Z\"}]}", "name": "" } ] }, { "name": "Create a new tenant invitation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-invitations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-invitations" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"\\\"new.user@example.com\\\"\",\"role\":\"\\\"manager\\\"\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":17,\"tenant_id\":3,\"email\":\"new.user@example.com\",\"role\":\"manager\",\"state\":\"pending\",\"invited_by\":7,\"expires_at\":\"2026-03-14T09:00:00Z\",\"accepted_at\":null,\"accepted_by_user_id\":null,\"revoked_at\":null,\"created_at\":\"2026-03-07T09:00:00Z\",\"updated_at\":\"2026-03-07T09:00:00Z\"}}", "name": "" } ] }, { "name": "Resend a pending invitation and revoke the existing pending token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-invitations\/:invite\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-invitations\/:invite\/resend", "variable": [ { "id": "invite", "key": "invite", "value": "17", "description": "Invitation id." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":23,\"tenant_id\":3,\"email\":\"new.user@example.com\",\"role\":\"manager\",\"state\":\"pending\",\"invited_by\":7,\"expires_at\":\"2026-03-21T09:00:00Z\",\"accepted_at\":null,\"accepted_by_user_id\":null,\"revoked_at\":null,\"created_at\":\"2026-03-07T10:00:00Z\",\"updated_at\":\"2026-03-07T10:00:00Z\"}}", "name": "" } ] }, { "name": "Revoke a pending invitation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-invitations\/:invite\/revoke", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-invitations\/:invite\/revoke", "variable": [ { "id": "invite", "key": "invite", "value": "17", "description": "Invitation id." } ] }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":17,\"tenant_id\":3,\"email\":\"new.user@example.com\",\"role\":\"manager\",\"state\":\"revoked\",\"invited_by\":7,\"expires_at\":\"2026-03-14T09:00:00Z\",\"accepted_at\":null,\"accepted_by_user_id\":null,\"revoked_at\":\"2026-03-07T10:15:00Z\",\"created_at\":\"2026-03-07T09:00:00Z\",\"updated_at\":\"2026-03-07T10:15:00Z\"}}", "name": "" } ] } ] }, { "name": "Tenant Members", "description": "", "item": [ { "name": "List active and archived tenant memberships.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-members", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-members" }, "method": "GET", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"active\":[{\"tenant_id\":3,\"user_id\":42,\"name\":\"Aisling O'Neill\",\"email\":\"aisling@example.com\",\"role\":\"admin\",\"membership_state\":\"active\",\"archived_at\":null,\"archived_by\":null,\"reactivated_at\":null,\"reactivated_by\":null}],\"archived\":[{\"tenant_id\":3,\"user_id\":51,\"name\":\"Niall Byrne\",\"email\":\"niall@example.com\",\"role\":\"member\",\"membership_state\":\"archived\",\"archived_at\":\"2026-02-21T09:30:00Z\",\"archived_by\":42,\"reactivated_at\":null,\"reactivated_by\":null}]}}", "name": "" } ] }, { "name": "Archive a non-owner tenant membership.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-members\/:user\/archive", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-members\/:user\/archive", "variable": [ { "id": "user", "key": "user", "value": "42", "description": "Tenant user id." } ] }, "method": "PATCH", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"tenant_id\":3,\"user_id\":42,\"name\":\"Aisling O'Neill\",\"email\":\"aisling@example.com\",\"role\":\"member\",\"membership_state\":\"archived\",\"archived_at\":\"2026-03-07T10:15:00Z\",\"archived_by\":7,\"reactivated_at\":null,\"reactivated_by\":null}}", "name": "" } ] }, { "name": "Reactivate an archived tenant membership.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-members\/:user\/reactivate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-members\/:user\/reactivate", "variable": [ { "id": "user", "key": "user", "value": "42", "description": "Tenant user id." } ] }, "method": "PATCH", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"tenant_id\":3,\"user_id\":42,\"name\":\"Aisling O'Neill\",\"email\":\"aisling@example.com\",\"role\":\"member\",\"membership_state\":\"active\",\"archived_at\":\"2026-03-01T10:15:00Z\",\"archived_by\":7,\"reactivated_at\":\"2026-03-07T11:05:00Z\",\"reactivated_by\":7}}", "name": "" } ] }, { "name": "Update a tenant member role without using ownership transfer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-members\/:user\/role", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-members\/:user\/role", "variable": [ { "id": "user", "key": "user", "value": "42", "description": "Tenant user id." } ] }, "method": "PATCH", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"role\":\"\\\"viewer\\\"\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"tenant_id\":3,\"user_id\":42,\"name\":\"Aisling O'Neill\",\"email\":\"aisling@example.com\",\"role\":\"viewer\",\"membership_state\":\"active\",\"archived_at\":null,\"archived_by\":null,\"reactivated_at\":null,\"reactivated_by\":null}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"Archived memberships must be reactivated before changing the user type.\",\"code\":\"tenancy.invalid_state\"}", "name": "" } ] }, { "name": "Transfer tenant ownership to an existing active admin.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tenant-members\/transfer-ownership", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tenant-members\/transfer-ownership" }, "method": "POST", "header": [ { "key": "X-Tenant", "value": "string required Tenant slug; required for tenant-scoped endpoints. Example: \"acme\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"target_user_id\":42}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"status\":\"ok\"}}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "type": "string" } ] } }