{ "version": "90bdda12e80e", "base_path": "/api/agent", "tools": [ { "name": "me", "capability": "me", "title": "Who am I", "description": "Returns the user and office this API key acts for, the key's scopes (what it may do) and the rate limits. Call it first to learn which operations are available; needs no scope.", "scope": null, "input_schema": { "type": "object", "properties": {}, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "office": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "timezone": { "type": "string", "description": "IANA zone the API reads and writes timestamps in, e.g. Europe/Budapest." }, "currency_id": { "type": "integer", "description": "The office currency (Flowyer currency id): costs.create books in it when currency_id is omitted." }, "currency": { "type": [ "string", "null" ], "description": "ISO code of the office currency, e.g. HUF, EUR, RON." } }, "additionalProperties": false }, "key": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string", "description": "Name the user gave this key, or the connected app for an OAuth token." }, "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\" = a static API key, \"oauth\" = an OAuth 2.1 access token." }, "prefix": { "type": [ "string", "null" ], "description": "First characters of a static key, for identification only; null for OAuth." }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_used_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Scopes of this credential, e.g. \"matters:read\". An operation whose scope is missing answers 403." }, "available_scopes": { "type": "array", "items": { "type": "string" }, "description": "All scopes the key owner could enable in Flowyer." }, "limits": { "type": "object", "properties": { "requests_per_minute": { "type": "integer" }, "list_max_limit": { "type": "integer" } }, "additionalProperties": false }, "channel": { "type": "string", "enum": [ "rest", "mcp" ], "description": "How the request reached Flowyer." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/me", "args": {} } }, { "name": "colleagues_list", "capability": "colleagues.list", "title": "List colleagues", "description": "Lists the active colleagues of the office (id, name) for assigned_to_user_id / responsible_user_id. With `q` (a name as heard; accents, casing and small typos tolerated) answers status exact/similar/none like the resolve tools: only \"exact\" is safe to use directly.", "scope": "colleagues:read", "input_schema": { "type": "object", "properties": { "q": { "type": "string", "maxLength": 255, "description": "A colleague's name to look up, as heard or dictated, in any word order. Omit it to list every active colleague.", "examples": [ "Nagy Péter" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 500, "description": "Maximum colleagues to return (default 200).", "default": 200 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "status": { "type": [ "string", "null" ], "enum": [ "exact", "similar", "none", null ], "description": "Only with `q`: exact = one confident match (safe to use its id), similar = approximate or several matches (confirm with the user first), none = no match (ask the user). Null without `q`." }, "colleagues": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "User id: pass it as assigned_to_user_id / responsible_user_id." }, "name": { "type": "string", "description": "Display name as Flowyer shows it (with the title, if any)." }, "title": { "type": [ "string", "null" ], "description": "Name prefix such as \"Dr.\", or null." } }, "additionalProperties": false }, "description": "Active colleagues, best match first with `q`, otherwise by name." }, "total": { "type": "integer", "description": "How many colleagues matched (all active colleagues without `q`) before the list was cut to `limit`." }, "truncated": { "type": "boolean", "description": "True when more colleagues matched than were returned: narrow `q` or raise `limit`." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/colleagues", "args": { "q": "query", "limit": "query" } } }, { "name": "matters_list", "capability": "matters.list", "title": "List matters", "description": "Lists the matters (cases) the user may see, newest first. Use it to find a matter by case number, subject or client before referring to it elsewhere. Archived matters are hidden unless `include_archived` is true. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "matters:read", "input_schema": { "type": "object", "properties": { "q": { "type": "string", "maxLength": 100, "description": "Free-text search in the subject and the client names (accents and case ignored) and the office's other case numbers; or a case number, either exactly as returned in case_number (the office numbering scheme) or as year/sequence such as \"2026/0025\".", "examples": [ "2026/0025" ] }, "client_id": { "type": "integer", "minimum": 1, "description": "Only matters of this client.", "examples": [ 512 ] }, "responsible_user_id": { "type": "integer", "minimum": 1, "description": "Only matters this user (ids from colleagues.list) is responsible for: as the main responsible, an additional responsible, or a member of a responsible workgroup (as the web colleague filter)." }, "updated_since": { "type": "string", "format": "date-time", "description": "Only matters changed at or after this time (ISO 8601).", "examples": [ "2026-10-01T00:00:00+02:00" ] }, "include_archived": { "type": "boolean", "description": "Include archived matters.", "default": false }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Matter id. Use it as `matter_id` elsewhere.", "examples": [ 1234 ] }, "case_number": { "type": "string", "description": "Case number as displayed in Flowyer, in the office numbering scheme.", "examples": [ "2026/0025" ] }, "subject": { "type": "string", "examples": [ "Kovács Kft. v. Nagy Bt. - contract dispute" ] }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "case_type_id": { "type": [ "integer", "null" ] }, "case_type": { "type": [ "string", "null" ], "description": "Localized name of the case type." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ], "description": "Display name of the responsible lawyer." }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false }, "description": "Clients (principals) of the matter." }, "started_on": { "type": [ "string", "null" ], "format": "date" }, "restricted": { "type": "boolean", "description": "True when only the responsible lawyers may see the matter (Chinese wall)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false, "description": "Present when an external agent created the record through this API." } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/matters", "args": { "q": "query", "client_id": "query", "responsible_user_id": "query", "updated_since": "query", "include_archived": "query", "limit": "query", "offset": "query" } } }, { "name": "matters_resolve", "capability": "matters.resolve", "title": "Resolve matter by name", "description": "Finds a matter by a spoken or misspelled subject or client name (accents, casing, small typos tolerated). Returns status exact/similar/none and candidates. Only \"exact\" is safe to use directly; else confirm with the user. Many lookalikes are never \"exact\": narrow with client_id or a fuller name.", "scope": "matters:read", "input_schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "description": "Matter subject or client name to look up, as heard or dictated.", "examples": [ "ingatlan adásvétel" ] }, "client_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Only matters of this client (use after clients.resolve returned an exact client)." }, "limit": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Maximum candidates to return (default 5).", "default": 5 } }, "additionalProperties": false, "required": [ "name" ] }, "output_schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "exact", "similar", "none" ], "description": "exact = one confident match (safe to use its id). similar = one or more approximate matches, confirm with the user first. none = no match, ask the user." }, "matters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Matter id. Use it as `matter_id` elsewhere.", "examples": [ 1234 ] }, "case_number": { "type": "string", "description": "Case number as displayed in Flowyer, in the office numbering scheme.", "examples": [ "2026/0025" ] }, "subject": { "type": "string", "examples": [ "Kovács Kft. v. Nagy Bt. - contract dispute" ] }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "case_type_id": { "type": [ "integer", "null" ] }, "case_type": { "type": [ "string", "null" ], "description": "Localized name of the case type." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ], "description": "Display name of the responsible lawyer." }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false }, "description": "Clients (principals) of the matter." }, "started_on": { "type": [ "string", "null" ], "format": "date" }, "restricted": { "type": "boolean", "description": "True when only the responsible lawyers may see the matter (Chinese wall)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false, "description": "Present when an external agent created the record through this API." } }, "additionalProperties": false }, "description": "Candidate matters, best match first." }, "total": { "type": "integer", "description": "How many matters matched before the list was cut to `limit`." }, "truncated": { "type": "boolean", "description": "True when more matters matched than were returned, or too many lookalikes existed to check them all; narrow with client_id or a fuller name, or raise `limit`, rather than choosing from an incomplete list." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/matters/resolve", "args": { "name": "query", "client_id": "query", "limit": "query" } } }, { "name": "matters_get", "capability": "matters.get", "title": "Get matter", "description": "Returns one matter (case) with its clients and details. Answers 404 when the matter does not exist or the user may not see it.", "scope": "matters:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter id.", "examples": [ 1234 ] } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Matter id. Use it as `matter_id` elsewhere.", "examples": [ 1234 ] }, "case_number": { "type": "string", "description": "Case number as displayed in Flowyer, in the office numbering scheme.", "examples": [ "2026/0025" ] }, "subject": { "type": "string", "examples": [ "Kovács Kft. v. Nagy Bt. - contract dispute" ] }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "case_type_id": { "type": [ "integer", "null" ] }, "case_type": { "type": [ "string", "null" ], "description": "Localized name of the case type." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ], "description": "Display name of the responsible lawyer." }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false }, "description": "Clients (principals) of the matter." }, "started_on": { "type": [ "string", "null" ], "format": "date" }, "restricted": { "type": "boolean", "description": "True when only the responsible lawyers may see the matter (Chinese wall)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false, "description": "Present when an external agent created the record through this API." }, "description": { "type": [ "string", "null" ] }, "litigious": { "type": "boolean" }, "archived_at": { "type": [ "string", "null" ], "format": "date", "description": "Day the matter was archived, YYYY-MM-DD. Flowyer records the date only, no time of day." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/matters/{id}", "args": { "id": "path" } } }, { "name": "matters_create", "capability": "matters.create", "title": "Create matter", "description": "Opens a matter (case) with the next case number of the year. Needs at least one existing client (find or create it first). The responsible lawyer defaults to the key's user and is notified otherwise. Parties, contacts and fees are set in Flowyer.", "scope": "matters:create", "input_schema": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 255, "minLength": 2, "pattern": "^[^<>]*$", "description": "Short title of the matter as it appears in lists. Plain text; \"<\" and \">\" are not allowed.", "examples": [ "Kovács Kft. v. Nagy Bt. - contract dispute" ] }, "case_type_id": { "type": "integer", "minimum": 1, "description": "Case type (area of law) id from the global Flowyer case-type list: pick the one whose name matches the user's words, or ask the user to choose by name. An unknown id answers 422 with details.known_case_types (id + localized name); an existing matter shows its type in matters.get `case_type_id` / `case_type`." }, "client_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "minItems": 1, "maxItems": 20, "description": "Ids of the clients (principals). At least one, at most 20.", "examples": [ [ 512 ] ] }, "responsible_user_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Responsible lawyer: a user id from colleagues.list (look a dictated name up there). Default: the user behind the key." }, "started_on": { "type": [ "string", "null" ], "format": "date", "description": "Start date, YYYY-MM-DD. Default: today.", "examples": [ "2026-10-29" ] }, "description": { "type": [ "string", "null" ], "maxLength": 10000, "description": "Longer description, plain text." }, "main_case_number": { "type": [ "string", "null" ], "maxLength": 100, "description": "The office's own main reference number of the matter. Required when the office numbering scheme uses it (the API answers 422 otherwise)." }, "restricted": { "type": "boolean", "description": "true = only the responsible lawyers may see the matter (Chinese wall).", "default": false }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "subject", "case_type_id", "client_ids" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Matter id. Use it as `matter_id` elsewhere.", "examples": [ 1234 ] }, "case_number": { "type": "string", "description": "Case number as displayed in Flowyer, in the office numbering scheme.", "examples": [ "2026/0025" ] }, "subject": { "type": "string", "examples": [ "Kovács Kft. v. Nagy Bt. - contract dispute" ] }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "case_type_id": { "type": [ "integer", "null" ] }, "case_type": { "type": [ "string", "null" ], "description": "Localized name of the case type." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ], "description": "Display name of the responsible lawyer." }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false }, "description": "Clients (principals) of the matter." }, "started_on": { "type": [ "string", "null" ], "format": "date" }, "restricted": { "type": "boolean", "description": "True when only the responsible lawyers may see the matter (Chinese wall)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false, "description": "Present when an external agent created the record through this API." }, "description": { "type": [ "string", "null" ] }, "litigious": { "type": "boolean" }, "archived_at": { "type": [ "string", "null" ], "format": "date", "description": "Day the matter was archived, YYYY-MM-DD. Flowyer records the date only, no time of day." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/matters", "args": { "subject": "body", "case_type_id": "body", "client_ids": "body", "responsible_user_id": "body", "started_on": "body", "description": "body", "main_case_number": "body", "restricted": "body", "idempotency_key": "idempotency-header" } } }, { "name": "matters_update", "capability": "matters.update", "title": "Update matter", "description": "Changes a matter's subject, description, start date, litigious flag or responsible lawyer. Case number, Chinese wall, archive status, fees and client links are not editable here. Pass expected_updated_at from your last read; a conflicting change answers 409.", "scope": "matters:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "subject": { "type": [ "string", "null" ], "minLength": 1, "description": "Short title of the matter. Plain text, at most 255 characters as a NEW value; \"<\" and \">\" cannot be introduced either, but a stored subject that is longer or contains them may be sent back unchanged. null keeps the current subject." }, "description": { "type": [ "string", "null" ], "description": "Longer description, plain text, at most 10000 characters as a NEW value; a longer stored description may be sent back unchanged." }, "started_on": { "type": [ "string", "null" ], "format": "date", "description": "Start date, YYYY-MM-DD. null keeps the current value (a start date cannot be cleared)." }, "litigious": { "type": "boolean", "description": "Whether the matter is litigious." }, "responsible_user_id": { "type": [ "integer", "null" ], "minimum": 0, "description": "New responsible lawyer: an active colleague's user id from colleagues.list. They are notified when it is not you. Sending the current one - or null / 0, which a matter without a responsible reads back as - changes nothing." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Matter id. Use it as `matter_id` elsewhere.", "examples": [ 1234 ] }, "case_number": { "type": "string", "description": "Case number as displayed in Flowyer, in the office numbering scheme.", "examples": [ "2026/0025" ] }, "subject": { "type": "string", "examples": [ "Kovács Kft. v. Nagy Bt. - contract dispute" ] }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "case_type_id": { "type": [ "integer", "null" ] }, "case_type": { "type": [ "string", "null" ], "description": "Localized name of the case type." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ], "description": "Display name of the responsible lawyer." }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false }, "description": "Clients (principals) of the matter." }, "started_on": { "type": [ "string", "null" ], "format": "date" }, "restricted": { "type": "boolean", "description": "True when only the responsible lawyers may see the matter (Chinese wall)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false, "description": "Present when an external agent created the record through this API." }, "description": { "type": [ "string", "null" ] }, "litigious": { "type": "boolean" }, "archived_at": { "type": [ "string", "null" ], "format": "date", "description": "Day the matter was archived, YYYY-MM-DD. Flowyer records the date only, no time of day." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/matters/{id}", "args": { "id": "path", "expected_updated_at": "body", "subject": "body", "description": "body", "started_on": "body", "litigious": "body", "responsible_user_id": "body" } } }, { "name": "matters_responsibles", "capability": "matters.responsibles", "title": "List matter responsibles", "description": "Lists the ADDITIONAL responsibles of a matter (the primary responsible is on matters.get): each is a colleague (type \"user\", user_id set) or a workgroup (type \"workgroup\", workgroup_id set), all of whom can see the matter. Answers 404 when the matter is not visible. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "matters:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter id.", "examples": [ 1234 ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "workgroup" ], "description": "\"user\" = a single colleague; \"workgroup\" = every member of a workgroup." }, "user_id": { "type": [ "integer", "null" ], "description": "Colleague user id for a \"user\" entry (pass it as user_id to matters.responsibles.add); null for a workgroup." }, "workgroup_id": { "type": [ "integer", "null" ], "description": "Workgroup id for a \"workgroup\" entry; null for a single colleague. Workgroup responsibles are managed in Flowyer." }, "name": { "type": [ "string", "null" ], "description": "Display name of the colleague or workgroup." } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/matters/{id}/responsibles", "args": { "id": "path", "limit": "query", "offset": "query" } } }, { "name": "matters_responsibles_add", "capability": "matters.responsibles.add", "title": "Add matter responsible", "description": "Adds a colleague (user_id from colleagues.list) as an additional responsible of a matter. This GIVES that colleague access to the matter, so only add someone who should see it; they are notified. Idempotent: re-adding an existing responsible makes no change.", "scope": "matters:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter the colleague becomes responsible for (must be visible).", "examples": [ 1234 ] }, "user_id": { "type": "integer", "minimum": 1, "description": "Colleague to add: a user id from colleagues.list. Adding them gives them access to the matter.", "examples": [ 42 ] } }, "additionalProperties": false, "required": [ "id", "user_id" ] }, "output_schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "The colleague now responsible for the matter." }, "name": { "type": [ "string", "null" ], "description": "Display name of the colleague." }, "already_responsible": { "type": "boolean", "description": "True when the colleague was already a responsible of the matter (nothing changed)." }, "notified": { "type": "boolean", "description": "True when the colleague was notified they were added. Never true when the colleague is you, or when they were already responsible." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "POST", "path": "/matters/{id}/responsibles", "args": { "id": "path", "user_id": "body" } } }, { "name": "clients_list", "capability": "clients.list", "title": "List clients", "description": "Lists the office's clients (persons and companies), alphabetically; `q` searches the name (accents and case ignored), e-mail and tax number. Before creating a client, check the name with clients.resolve (it tolerates typos too). Archived clients are hidden unless `include_archived` is true. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "clients:read", "input_schema": { "type": "object", "properties": { "q": { "type": "string", "maxLength": 100, "description": "Search in name (accents and case ignored), e-mail and tax number.", "examples": [ "Kovács" ] }, "is_person": { "type": "boolean", "description": "true = natural persons only, false = companies only." }, "include_archived": { "type": "boolean", "default": false }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Client id. Use it as `client_id` elsewhere.", "examples": [ 512 ] }, "name": { "type": "string", "examples": [ "Kovács Kft." ] }, "is_person": { "type": "boolean", "description": "True for a natural person, false for a company." }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "archived": { "type": "boolean" }, "recorded_by_user_id": { "type": [ "integer", "null" ] }, "recorded_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/clients", "args": { "q": "query", "is_person": "query", "include_archived": "query", "limit": "query", "offset": "query" } } }, { "name": "clients_resolve", "capability": "clients.resolve", "title": "Resolve client by name", "description": "Finds a client by a spoken or misspelled name (accents, casing and small typos tolerated). Returns status exact/similar/none and candidate clients. Only \"exact\" is safe to use directly; on \"similar\" or \"none\" ask the user. A name with many lookalikes is never \"exact\": ask for a fuller name.", "scope": "clients:read", "input_schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "description": "Client name to look up, as heard or dictated.", "examples": [ "Józsi ingatlan" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Maximum candidates to return (default 5).", "default": 5 } }, "additionalProperties": false, "required": [ "name" ] }, "output_schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "exact", "similar", "none" ], "description": "exact = one confident match (safe to use its id). similar = one or more approximate matches, confirm with the user first. none = no match, ask the user." }, "matches": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Client id. Use it as `client_id` elsewhere.", "examples": [ 512 ] }, "name": { "type": "string", "examples": [ "Kovács Kft." ] }, "is_person": { "type": "boolean", "description": "True for a natural person, false for a company." }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "archived": { "type": "boolean" }, "recorded_by_user_id": { "type": [ "integer", "null" ] }, "recorded_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false } }, "additionalProperties": false }, "description": "Candidate clients, best match first." }, "total": { "type": "integer", "description": "How many clients matched before the list was cut to `limit`." }, "truncated": { "type": "boolean", "description": "True when more clients matched than were returned, or too many lookalikes existed to check them all; ask the user for a fuller name or raise `limit` rather than choosing from an incomplete list." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/clients/resolve", "args": { "name": "query", "limit": "query" } } }, { "name": "clients_get", "capability": "clients.get", "title": "Get client", "description": "Returns one client with address and registration details. Identity-document numbers and fee settings are never returned.", "scope": "clients:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Client id.", "examples": [ 512 ] } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Client id. Use it as `client_id` elsewhere.", "examples": [ 512 ] }, "name": { "type": "string", "examples": [ "Kovács Kft." ] }, "is_person": { "type": "boolean", "description": "True for a natural person, false for a company." }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "archived": { "type": "boolean" }, "recorded_by_user_id": { "type": [ "integer", "null" ] }, "recorded_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "address": { "type": "object", "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false }, "mailing_address": { "type": "object", "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false }, "tax_number": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "company_registration_number": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "representative_name": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "representative_position": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "main_activity": { "type": [ "string", "null" ], "description": "Main scope of activity. Companies only; null for a natural person." }, "nationality_country": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/clients/{id}", "args": { "id": "path" } } }, { "name": "clients_create", "capability": "clients.create", "title": "Create client", "description": "Creates a client (person or company), recorded as created by the key's user. Check the name with clients.resolve first (it tolerates missing accents and typos): a 409 only catches an active client of the very same name, unless `allow_duplicate_name` is true. ID numbers and fees cannot be set.", "scope": "clients:create", "input_schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 2, "pattern": "^[^<>]*$", "description": "Full name of the person or the company name. Plain text; \"<\" and \">\" are not allowed.", "examples": [ "Kovács Kft." ] }, "is_person": { "type": "boolean", "description": "true for a natural person, false (default) for a company.", "default": false }, "email": { "type": [ "string", "null" ], "maxLength": 190, "examples": [ "info@kovacskft.hu" ] }, "phone": { "type": [ "string", "null" ], "maxLength": 64, "examples": [ "+36 1 234 5678" ] }, "address": { "type": [ "object", "null" ], "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false, "description": "Registered / home address." }, "mailing_address": { "type": [ "object", "null" ], "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false }, "tax_number": { "type": [ "string", "null" ], "maxLength": 64, "description": "Company tax number (companies only).", "examples": [ "12345678-2-41" ] }, "company_registration_number": { "type": [ "string", "null" ], "maxLength": 64, "description": "Company registration number (companies only).", "examples": [ "01-09-123456" ] }, "representative_name": { "type": [ "string", "null" ], "maxLength": 255, "description": "Companies only." }, "representative_position": { "type": [ "string", "null" ], "maxLength": 255, "description": "Companies only." }, "main_activity": { "type": [ "string", "null" ], "maxLength": 255, "description": "Main scope of activity (companies only)." }, "nationality_country": { "type": [ "string", "null" ], "maxLength": 100 }, "note": { "type": [ "string", "null" ], "maxLength": 4000 }, "allow_duplicate_name": { "type": "boolean", "description": "Create even if an active client with the same name exists.", "default": false }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "name" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Client id. Use it as `client_id` elsewhere.", "examples": [ 512 ] }, "name": { "type": "string", "examples": [ "Kovács Kft." ] }, "is_person": { "type": "boolean", "description": "True for a natural person, false for a company." }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "archived": { "type": "boolean" }, "recorded_by_user_id": { "type": [ "integer", "null" ] }, "recorded_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "address": { "type": "object", "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false }, "mailing_address": { "type": "object", "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false }, "tax_number": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "company_registration_number": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "representative_name": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "representative_position": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "main_activity": { "type": [ "string", "null" ], "description": "Main scope of activity. Companies only; null for a natural person." }, "nationality_country": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/clients", "args": { "name": "body", "is_person": "body", "email": "body", "phone": "body", "address": "body", "mailing_address": "body", "tax_number": "body", "company_registration_number": "body", "representative_name": "body", "representative_position": "body", "main_activity": "body", "nationality_country": "body", "note": "body", "allow_duplicate_name": "body", "idempotency_key": "idempotency-header" } } }, { "name": "clients_update", "capability": "clients.update", "title": "Update client", "description": "Changes a client's contact fields (name, email, phone, address, note, nationality, and company representative/activity). ID numbers, tax numbers, fees and the person/company type are not editable here. Pass expected_updated_at; a conflicting change answers 409.", "scope": "clients:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "name": { "type": [ "string", "null" ], "minLength": 1, "description": "Full name or company name. Plain text, at most 255 characters as a NEW value; \"<\" and \">\" cannot be introduced either, but a stored name that is longer or contains them may be sent back unchanged. null keeps the current name." }, "email": { "type": [ "string", "null" ], "maxLength": 190 }, "phone": { "type": [ "string", "null" ], "maxLength": 64 }, "address": { "type": [ "object", "null" ], "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false, "description": "Registered / home address." }, "mailing_address": { "type": [ "object", "null" ], "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false }, "representative_name": { "type": [ "string", "null" ], "maxLength": 255, "description": "Companies only." }, "representative_position": { "type": [ "string", "null" ], "maxLength": 255, "description": "Companies only." }, "main_activity": { "type": [ "string", "null" ], "maxLength": 255, "description": "Main scope of activity (companies only)." }, "nationality_country": { "type": [ "string", "null" ], "maxLength": 100 }, "note": { "type": [ "string", "null" ], "description": "Free-text note, at most 4000 characters as a NEW value; a longer stored note may be sent back unchanged. null clears the note." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Client id. Use it as `client_id` elsewhere.", "examples": [ 512 ] }, "name": { "type": "string", "examples": [ "Kovács Kft." ] }, "is_person": { "type": "boolean", "description": "True for a natural person, false for a company." }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "archived": { "type": "boolean" }, "recorded_by_user_id": { "type": [ "integer", "null" ] }, "recorded_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "address": { "type": "object", "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false }, "mailing_address": { "type": "object", "properties": { "zip": { "type": [ "string", "null" ], "maxLength": 20 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "street": { "type": [ "string", "null" ], "maxLength": 255 } }, "additionalProperties": false }, "tax_number": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "company_registration_number": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "representative_name": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "representative_position": { "type": [ "string", "null" ], "description": "Companies only; null for a natural person." }, "main_activity": { "type": [ "string", "null" ], "description": "Main scope of activity. Companies only; null for a natural person." }, "nationality_country": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/clients/{id}", "args": { "id": "path", "expected_updated_at": "body", "name": "body", "email": "body", "phone": "body", "address": "body", "mailing_address": "body", "representative_name": "body", "representative_position": "body", "main_activity": "body", "nationality_country": "body", "note": "body" } } }, { "name": "tasks_list", "capability": "tasks.list", "title": "List tasks", "description": "Lists tasks (to-dos with a deadline) the user may see, soonest deadline first. Open tasks by default; filter by assignee, matter, client or deadline range. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "tasks:read", "input_schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "open", "closed", "all" ], "description": "open (default), closed or all.", "default": "open" }, "assigned_to_user_id": { "type": "integer", "minimum": 1, "description": "Only tasks assigned to this user (a user id from colleagues.list)." }, "matter_id": { "type": "integer", "minimum": 1, "description": "Only tasks of this matter." }, "client_id": { "type": "integer", "minimum": 1, "description": "Only caseless tasks of this client." }, "deadline_from": { "type": "string", "format": "date", "description": "Deadline on or after this date.", "examples": [ "2026-11-01" ] }, "deadline_to": { "type": "string", "format": "date", "description": "Deadline on or before this date.", "examples": [ "2026-11-30" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "subject": { "type": "string", "examples": [ "Submit the statement of defence" ] }, "description": { "type": [ "string", "null" ] }, "deadline": { "type": [ "string", "null" ], "format": "date", "description": "Due date, YYYY-MM-DD.", "examples": [ "2026-11-15" ] }, "priority": { "type": [ "integer", "null" ], "description": "1 = low, 2 = medium, 3 = high; null = not set (an older task without a priority).", "examples": [ 2 ] }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date", "description": "Day the task was closed, YYYY-MM-DD. Flowyer records the date only, no time of day." }, "matter": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "case_number": { "type": "string" } }, "additionalProperties": false, "description": "The matter the task belongs to, if any." }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "description": "The client: the matter's first client, or the task's own client when it has no matter." }, "assigned_to_user_id": { "type": [ "integer", "null" ] }, "assigned_to": { "type": [ "string", "null" ] }, "created_by_user_id": { "type": [ "integer", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "flag_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/tasks", "args": { "status": "query", "assigned_to_user_id": "query", "matter_id": "query", "client_id": "query", "deadline_from": "query", "deadline_to": "query", "limit": "query", "offset": "query" } } }, { "name": "tasks_get", "capability": "tasks.get", "title": "Get task", "description": "Returns one task. Answers 404 when the task does not exist or the user may not see it.", "scope": "tasks:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Task id.", "examples": [ 9876 ] } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "subject": { "type": "string", "examples": [ "Submit the statement of defence" ] }, "description": { "type": [ "string", "null" ] }, "deadline": { "type": [ "string", "null" ], "format": "date", "description": "Due date, YYYY-MM-DD.", "examples": [ "2026-11-15" ] }, "priority": { "type": [ "integer", "null" ], "description": "1 = low, 2 = medium, 3 = high; null = not set (an older task without a priority).", "examples": [ 2 ] }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date", "description": "Day the task was closed, YYYY-MM-DD. Flowyer records the date only, no time of day." }, "matter": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "case_number": { "type": "string" } }, "additionalProperties": false, "description": "The matter the task belongs to, if any." }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "description": "The client: the matter's first client, or the task's own client when it has no matter." }, "assigned_to_user_id": { "type": [ "integer", "null" ] }, "assigned_to": { "type": [ "string", "null" ] }, "created_by_user_id": { "type": [ "integer", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "flag_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/tasks/{id}", "args": { "id": "path" } } }, { "name": "tasks_create", "capability": "tasks.create", "title": "Create task", "description": "Creates a task (to-do with a deadline), either on a matter (`matter_id`, visible and not archived) or caseless, optionally for a client (`client_id`). The assignee defaults to the key's user and is notified when it is someone else.", "scope": "tasks:create", "input_schema": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 1000, "minLength": 2, "description": "What has to be done. Plain text.", "examples": [ "Submit the statement of defence" ] }, "deadline": { "type": "string", "format": "date", "description": "Due date, YYYY-MM-DD.", "examples": [ "2026-11-15" ] }, "matter_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Matter the task belongs to. Omit for a caseless task.", "examples": [ 1234 ] }, "client_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Client of a caseless task. Not allowed together with matter_id (a matter's task takes the matter's client)." }, "assigned_to_user_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Colleague responsible for the task: a user id from colleagues.list (look a dictated name up there). Default: the user behind the key." }, "priority": { "type": "integer", "minimum": 1, "maximum": 3, "description": "1 = low, 2 = medium (default), 3 = high.", "default": 2 }, "description": { "type": [ "string", "null" ], "maxLength": 10000, "description": "Longer details, plain text." }, "flag_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Id of an office task flag (label)." }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "subject", "deadline" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "subject": { "type": "string", "examples": [ "Submit the statement of defence" ] }, "description": { "type": [ "string", "null" ] }, "deadline": { "type": [ "string", "null" ], "format": "date", "description": "Due date, YYYY-MM-DD.", "examples": [ "2026-11-15" ] }, "priority": { "type": [ "integer", "null" ], "description": "1 = low, 2 = medium, 3 = high; null = not set (an older task without a priority).", "examples": [ 2 ] }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date", "description": "Day the task was closed, YYYY-MM-DD. Flowyer records the date only, no time of day." }, "matter": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "case_number": { "type": "string" } }, "additionalProperties": false, "description": "The matter the task belongs to, if any." }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "description": "The client: the matter's first client, or the task's own client when it has no matter." }, "assigned_to_user_id": { "type": [ "integer", "null" ] }, "assigned_to": { "type": [ "string", "null" ] }, "created_by_user_id": { "type": [ "integer", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "flag_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/tasks", "args": { "subject": "body", "deadline": "body", "matter_id": "body", "client_id": "body", "assigned_to_user_id": "body", "priority": "body", "description": "body", "flag_id": "body", "idempotency_key": "idempotency-header" } } }, { "name": "tasks_update", "capability": "tasks.update", "title": "Update task", "description": "Changes a task: subject, deadline, description, priority, flag, assignee or the matter it belongs to. Moving it onto a matter re-derives the court link and drops a direct client; client_id is only for a caseless task. Pass expected_updated_at; a conflicting change answers 409.", "scope": "tasks:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "subject": { "type": [ "string", "null" ], "minLength": 1, "description": "What has to be done. Plain text, at most 1000 characters as a NEW value; a longer stored subject may be sent back unchanged. null keeps the current subject." }, "deadline": { "type": [ "string", "null" ], "format": "date", "description": "Due date, YYYY-MM-DD. null keeps the current deadline (a deadline cannot be cleared)." }, "matter_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Move the task onto this matter (must be visible and not archived), or null to detach it. Sending the task's current matter changes nothing." }, "client_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Client of a caseless task. Only allowed when the task has no matter." }, "assigned_to_user_id": { "type": [ "integer", "null" ], "minimum": 0, "description": "New assignee: an active colleague's user id from colleagues.list. Notified when it is not you. Sending the current one - or null / 0, which a task without an assignee reads back as - changes nothing." }, "priority": { "type": "integer", "minimum": 1, "maximum": 3, "description": "1 = low, 2 = medium, 3 = high. Omit it to keep the current priority (also when the task reads back with priority null); null is refused." }, "description": { "type": [ "string", "null" ], "description": "Longer details, plain text, at most 10000 characters as a NEW value; a longer stored description may be sent back unchanged." }, "flag_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Id of an office task flag (label), or null to clear it." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "subject": { "type": "string", "examples": [ "Submit the statement of defence" ] }, "description": { "type": [ "string", "null" ] }, "deadline": { "type": [ "string", "null" ], "format": "date", "description": "Due date, YYYY-MM-DD.", "examples": [ "2026-11-15" ] }, "priority": { "type": [ "integer", "null" ], "description": "1 = low, 2 = medium, 3 = high; null = not set (an older task without a priority).", "examples": [ 2 ] }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date", "description": "Day the task was closed, YYYY-MM-DD. Flowyer records the date only, no time of day." }, "matter": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "case_number": { "type": "string" } }, "additionalProperties": false, "description": "The matter the task belongs to, if any." }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "description": "The client: the matter's first client, or the task's own client when it has no matter." }, "assigned_to_user_id": { "type": [ "integer", "null" ] }, "assigned_to": { "type": [ "string", "null" ] }, "created_by_user_id": { "type": [ "integer", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "flag_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/tasks/{id}", "args": { "id": "path", "expected_updated_at": "body", "subject": "body", "deadline": "body", "matter_id": "body", "client_id": "body", "assigned_to_user_id": "body", "priority": "body", "description": "body", "flag_id": "body" } } }, { "name": "tasks_close", "capability": "tasks.close", "title": "Close task", "description": "Closes a task. If minutes are given it also books a time entry (needs workhours:create and a case: the task's own, or matter_id on a caseless task); billable minutes are clipped to the office hour-cap. A second close answers 409, so a retry never books a second entry.", "scope": "tasks:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Task id.", "examples": [ 9876 ] }, "minutes_spent": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Time spent, in minutes. Booking any time needs the workhours:create scope and a case." }, "minutes_invoiceable": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Billable minutes; clipped to the office hour-cap." }, "minutes_normative": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Normative minutes; stored raw, never capped." }, "matter_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Assign this case to a CASELESS task at close (and so make it possible to book time). Not allowed when the task already has a case." }, "client_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Direct client (Megbízó) for a caseless task closed without a case." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "subject": { "type": "string", "examples": [ "Submit the statement of defence" ] }, "description": { "type": [ "string", "null" ] }, "deadline": { "type": [ "string", "null" ], "format": "date", "description": "Due date, YYYY-MM-DD.", "examples": [ "2026-11-15" ] }, "priority": { "type": [ "integer", "null" ], "description": "1 = low, 2 = medium, 3 = high; null = not set (an older task without a priority).", "examples": [ 2 ] }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date", "description": "Day the task was closed, YYYY-MM-DD. Flowyer records the date only, no time of day." }, "matter": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "case_number": { "type": "string" } }, "additionalProperties": false, "description": "The matter the task belongs to, if any." }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false, "description": "The client: the matter's first client, or the task's own client when it has no matter." }, "assigned_to_user_id": { "type": [ "integer", "null" ] }, "assigned_to": { "type": [ "string", "null" ] }, "created_by_user_id": { "type": [ "integer", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "flag_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_via_api": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "enum": [ "key", "oauth" ], "description": "\"key\": created with a static API key; \"oauth\": created by an app connected through OAuth." }, "key_id": { "type": "integer", "description": "Id of the API key (kind \"key\") or of the connected app (kind \"oauth\"); the two are numbered separately." }, "key_name": { "type": "string", "description": "Name the user gave the API key, e.g. \"Grok integration\", or the connected app's name for kind \"oauth\", e.g. \"Claude\"." }, "user_id": { "type": "integer" }, "user": { "type": [ "string", "null" ] }, "at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "booked_workhour": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "minimum": 1 }, "minutes": { "type": "integer" }, "minutes_invoiceable": { "type": "integer" }, "minutes_normative": { "type": "integer" } }, "additionalProperties": false, "description": "The time entry booked from the close, or null when no time was entered." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "POST", "path": "/tasks/{id}/close", "args": { "id": "path", "minutes_spent": "body", "minutes_invoiceable": "body", "minutes_normative": "body", "matter_id": "body", "client_id": "body" } } }, { "name": "workhours_list", "capability": "workhours.list", "title": "List time entries", "description": "Lists live (not yet invoiced) time entries on matters the user may see, newest first. Filter by matter, responsible colleague or date range. Entries excluded from the summary are listed too, flagged excluded: true; leave them out of billable totals. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "workhours:read", "input_schema": { "type": "object", "properties": { "matter_id": { "type": "integer", "minimum": 1, "description": "Only entries on this matter.", "examples": [ 1234 ] }, "responsible_user_id": { "type": "integer", "minimum": 1, "description": "Only entries booked to this colleague (a user id from colleagues.list)." }, "date_from": { "type": "string", "format": "date", "description": "Only entries on or after this date (YYYY-MM-DD)." }, "date_to": { "type": "string", "format": "date", "description": "Only entries on or before this date (YYYY-MM-DD)." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Time entry id." }, "matter_id": { "type": [ "integer", "null" ], "description": "Matter the entry is booked to." }, "date": { "type": [ "string", "null" ], "format": "date" }, "activity": { "type": [ "string", "null" ], "description": "What was done (plain text)." }, "minutes": { "type": [ "integer", "null" ], "description": "Minutes spent." }, "minutes_invoiceable": { "type": [ "integer", "null" ], "description": "Billable minutes after the office hour-cap was applied (may be lower than requested). They count towards billing only while excluded is false." }, "minutes_normative": { "type": [ "integer", "null" ], "description": "Normative minutes (informational; never capped)." }, "responsible_user_id": { "type": [ "integer", "null" ], "description": "Colleague the time is booked to." }, "responsible": { "type": [ "string", "null" ] }, "recorded_by_user_id": { "type": [ "integer", "null" ], "description": "Who recorded the entry." }, "locked": { "type": "boolean", "description": "True when the entry is locked (read-only through the API)." }, "excluded": { "type": "boolean", "description": "True when a colleague excluded the entry from the matter summary: it is not billed and its minutes are left out of the billable totals." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Send this back as expected_updated_at when updating." } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/workhours", "args": { "matter_id": "query", "responsible_user_id": "query", "date_from": "query", "date_to": "query", "limit": "query", "offset": "query" } } }, { "name": "workhours_get", "capability": "workhours.get", "title": "Get time entry", "description": "Returns one live time entry by id, if its matter is visible to the user.", "scope": "workhours:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Time entry id." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Time entry id." }, "matter_id": { "type": [ "integer", "null" ], "description": "Matter the entry is booked to." }, "date": { "type": [ "string", "null" ], "format": "date" }, "activity": { "type": [ "string", "null" ], "description": "What was done (plain text)." }, "minutes": { "type": [ "integer", "null" ], "description": "Minutes spent." }, "minutes_invoiceable": { "type": [ "integer", "null" ], "description": "Billable minutes after the office hour-cap was applied (may be lower than requested). They count towards billing only while excluded is false." }, "minutes_normative": { "type": [ "integer", "null" ], "description": "Normative minutes (informational; never capped)." }, "responsible_user_id": { "type": [ "integer", "null" ], "description": "Colleague the time is booked to." }, "responsible": { "type": [ "string", "null" ] }, "recorded_by_user_id": { "type": [ "integer", "null" ], "description": "Who recorded the entry." }, "locked": { "type": "boolean", "description": "True when the entry is locked (read-only through the API)." }, "excluded": { "type": "boolean", "description": "True when a colleague excluded the entry from the matter summary: it is not billed and its minutes are left out of the billable totals." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Send this back as expected_updated_at when updating." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/workhours/{id}", "args": { "id": "path" } } }, { "name": "workhours_create", "capability": "workhours.create", "title": "Record time entry", "description": "Records a time entry on a matter: date, activity, minutes spent and billable minutes. Omitted billable minutes mean not billable: send minutes_invoiceable for billable work. They are clipped to the office hour-cap. The responsible colleague defaults to the key's user and is notified otherwise.", "scope": "workhours:create", "input_schema": { "type": "object", "properties": { "matter_id": { "type": "integer", "minimum": 1, "description": "Matter the time is booked to (must be visible).", "examples": [ 1234 ] }, "date": { "type": "string", "format": "date", "description": "Date of the work, YYYY-MM-DD.", "examples": [ "2026-10-30" ] }, "subject": { "type": "string", "maxLength": 1000, "minLength": 2, "pattern": "^[^<>]*$", "description": "What was done; the read side returns it as `activity` and either name is accepted here (one of the two is required). Plain text; \"<\" and \">\" are not allowed.", "examples": [ "Drafting the statement of claim" ] }, "activity": { "type": "string", "maxLength": 1000, "minLength": 2, "pattern": "^[^<>]*$", "description": "The same field as `subject`, under the name the read side uses. Send one of the two." }, "minutes": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Minutes actually spent.", "examples": [ 90 ] }, "minutes_invoiceable": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Billable minutes requested. Omitted or null = not billable (the entry bills nothing; they are not derived from minutes): for billable work send them explicitly, usually equal to minutes. The office hour-cap may reduce the stored value. They count towards billing only while the entry is not excluded from the summary.", "examples": [ 60 ] }, "minutes_normative": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Normative minutes (informational; never capped)." }, "responsible_user_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Colleague the time is booked to: a user id from colleagues.list (look a dictated name up there). Default: the user behind the key." }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "matter_id", "date" ], "anyOf": [ { "required": [ "subject" ] }, { "required": [ "activity" ] } ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Time entry id." }, "matter_id": { "type": [ "integer", "null" ], "description": "Matter the entry is booked to." }, "date": { "type": [ "string", "null" ], "format": "date" }, "activity": { "type": [ "string", "null" ], "description": "What was done (plain text)." }, "minutes": { "type": [ "integer", "null" ], "description": "Minutes spent." }, "minutes_invoiceable": { "type": [ "integer", "null" ], "description": "Billable minutes after the office hour-cap was applied (may be lower than requested). They count towards billing only while excluded is false." }, "minutes_normative": { "type": [ "integer", "null" ], "description": "Normative minutes (informational; never capped)." }, "responsible_user_id": { "type": [ "integer", "null" ], "description": "Colleague the time is booked to." }, "responsible": { "type": [ "string", "null" ] }, "recorded_by_user_id": { "type": [ "integer", "null" ], "description": "Who recorded the entry." }, "locked": { "type": "boolean", "description": "True when the entry is locked (read-only through the API)." }, "excluded": { "type": "boolean", "description": "True when a colleague excluded the entry from the matter summary: it is not billed and its minutes are left out of the billable totals." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Send this back as expected_updated_at when updating." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/workhours", "args": { "matter_id": "body", "date": "body", "subject": "body", "activity": "body", "minutes": "body", "minutes_invoiceable": "body", "minutes_normative": "body", "responsible_user_id": "body", "idempotency_key": "idempotency-header" } } }, { "name": "workhours_update", "capability": "workhours.update", "title": "Update time entry", "description": "Changes a live time entry: date, activity (`subject` or `activity`), minutes, billable minutes (a changed number is clipped to the hour-cap, an echoed one kept) and the responsible colleague. A locked or invoiced entry cannot be changed (409). Pass expected_updated_at; a conflict answers 409.", "scope": "workhours:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "date": { "type": [ "string", "null" ], "format": "date", "description": "Date of the work, YYYY-MM-DD. null keeps the current date." }, "subject": { "type": [ "string", "null" ], "minLength": 1, "description": "What was done, the value the read side returns as `activity` (either name is accepted; null under one of them is \"not given\", only two different texts are refused). Plain text, at most 1000 characters as a NEW value; \"<\" and \">\" cannot be introduced either, but a stored text that is longer or contains them may be sent back unchanged. null keeps the current text." }, "activity": { "type": [ "string", "null" ], "minLength": 1, "description": "The same field as `subject`, under the name the read side uses. Send one of the two (null under the other one is fine)." }, "minutes": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Minutes actually spent; null clears them." }, "minutes_invoiceable": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Billable minutes requested. A number different from the stored one is clipped to what is left of the hour-cap; re-sending the value the read returned keeps it as recorded (it is not clipped again). null clears them. They count towards billing only while the entry is not excluded from the summary (excluded is false)." }, "minutes_normative": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000, "description": "Normative minutes (never capped); null clears them." }, "responsible_user_id": { "type": [ "integer", "null" ], "minimum": 0, "description": "New responsible colleague: an active colleague's user id from colleagues.list; notified when it is not you. Sending the current one - or null / 0, which an entry without a responsible reads back as - changes nothing." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Time entry id." }, "matter_id": { "type": [ "integer", "null" ], "description": "Matter the entry is booked to." }, "date": { "type": [ "string", "null" ], "format": "date" }, "activity": { "type": [ "string", "null" ], "description": "What was done (plain text)." }, "minutes": { "type": [ "integer", "null" ], "description": "Minutes spent." }, "minutes_invoiceable": { "type": [ "integer", "null" ], "description": "Billable minutes after the office hour-cap was applied (may be lower than requested). They count towards billing only while excluded is false." }, "minutes_normative": { "type": [ "integer", "null" ], "description": "Normative minutes (informational; never capped)." }, "responsible_user_id": { "type": [ "integer", "null" ], "description": "Colleague the time is booked to." }, "responsible": { "type": [ "string", "null" ] }, "recorded_by_user_id": { "type": [ "integer", "null" ], "description": "Who recorded the entry." }, "locked": { "type": "boolean", "description": "True when the entry is locked (read-only through the API)." }, "excluded": { "type": "boolean", "description": "True when a colleague excluded the entry from the matter summary: it is not billed and its minutes are left out of the billable totals." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Send this back as expected_updated_at when updating." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/workhours/{id}", "args": { "id": "path", "expected_updated_at": "body", "date": "body", "subject": "body", "activity": "body", "minutes": "body", "minutes_invoiceable": "body", "minutes_normative": "body", "responsible_user_id": "body" } } }, { "name": "costs_list", "capability": "costs.list", "title": "List costs", "description": "Lists the live costs of matters the user may see, newest first (an invoiced cost is no longer here). Filter by matter, responsible colleague or date range. Amounts are net. Rows flagged excluded: true are out of the summary and rows flagged locked: true are managed by Flowyer. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "costs:read", "input_schema": { "type": "object", "properties": { "matter_id": { "type": "integer", "minimum": 1, "description": "Only costs on this matter.", "examples": [ 1234 ] }, "responsible_user_id": { "type": "integer", "minimum": 1, "description": "Only costs recorded for this colleague (a user id from colleagues.list)." }, "date_from": { "type": "string", "format": "date", "description": "Only costs on or after this date (YYYY-MM-DD)." }, "date_to": { "type": "string", "format": "date", "description": "Only costs on or before this date (YYYY-MM-DD)." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Cost id." }, "matter_id": { "type": [ "integer", "null" ], "description": "Matter the cost belongs to." }, "date": { "type": [ "string", "null" ], "format": "date" }, "activity": { "type": [ "string", "null" ], "description": "Description of the cost (plain text)." }, "cost": { "type": [ "number", "null" ], "description": "Net cost amount (no VAT)." }, "cost_invoiceable": { "type": [ "number", "null" ], "description": "Net amount to bill on to the client. It counts towards billing only while excluded is false." }, "currency_id": { "type": [ "integer", "null" ], "description": "Currency id (Flowyer currency list)." }, "currency": { "type": [ "string", "null" ], "description": "Currency ISO code, e.g. HUF, EUR." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ] }, "excluded": { "type": "boolean", "description": "True when a colleague excluded the cost from the matter summary: it is not billed and is left out of the billable totals." }, "locked": { "type": "boolean", "description": "True when the cost is managed by Flowyer - mirrored from an incoming invoice, or a disbursement surcharge - and cannot be changed through the API (costs.update answers 409 record_locked, details.reason says which)." }, "approved_for_billing": { "type": "boolean", "description": "True when a colleague approved the cost for billing in the matter summary. It stays editable through the API (as in the web), and the approval is NOT re-requested afterwards: say so before changing the amount of an approved cost." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Send this back as expected_updated_at when updating." } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/costs", "args": { "matter_id": "query", "responsible_user_id": "query", "date_from": "query", "date_to": "query", "limit": "query", "offset": "query" } } }, { "name": "costs_get", "capability": "costs.get", "title": "Get cost", "description": "Returns one live cost by id, if its matter is visible to the user. Amounts are net.", "scope": "costs:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Cost id." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Cost id." }, "matter_id": { "type": [ "integer", "null" ], "description": "Matter the cost belongs to." }, "date": { "type": [ "string", "null" ], "format": "date" }, "activity": { "type": [ "string", "null" ], "description": "Description of the cost (plain text)." }, "cost": { "type": [ "number", "null" ], "description": "Net cost amount (no VAT)." }, "cost_invoiceable": { "type": [ "number", "null" ], "description": "Net amount to bill on to the client. It counts towards billing only while excluded is false." }, "currency_id": { "type": [ "integer", "null" ], "description": "Currency id (Flowyer currency list)." }, "currency": { "type": [ "string", "null" ], "description": "Currency ISO code, e.g. HUF, EUR." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ] }, "excluded": { "type": "boolean", "description": "True when a colleague excluded the cost from the matter summary: it is not billed and is left out of the billable totals." }, "locked": { "type": "boolean", "description": "True when the cost is managed by Flowyer - mirrored from an incoming invoice, or a disbursement surcharge - and cannot be changed through the API (costs.update answers 409 record_locked, details.reason says which)." }, "approved_for_billing": { "type": "boolean", "description": "True when a colleague approved the cost for billing in the matter summary. It stays editable through the API (as in the web), and the approval is NOT re-requested afterwards: say so before changing the amount of an approved cost." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Send this back as expected_updated_at when updating." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/costs/{id}", "args": { "id": "path" } } }, { "name": "costs_create", "capability": "costs.create", "title": "Record cost", "description": "Records a cost (disbursement) on a matter: date, text (`subject`, read back as `activity`), net amount, net amount billed to the client, and currency (default: the office currency). Amounts are net (no VAT). The responsible colleague defaults to the key's user and is notified otherwise.", "scope": "costs:create", "input_schema": { "type": "object", "properties": { "matter_id": { "type": "integer", "minimum": 1, "description": "Matter the cost belongs to (must be visible).", "examples": [ 1234 ] }, "date": { "type": "string", "format": "date", "description": "Date of the cost, YYYY-MM-DD.", "examples": [ "2026-10-30" ] }, "subject": { "type": "string", "maxLength": 1000, "minLength": 2, "pattern": "^[^<>]*$", "description": "Description of the cost; the read side returns it as `activity` and either name is accepted here (one of the two is required). Plain text; \"<\" and \">\" are not allowed.", "examples": [ "Court filing fee" ] }, "activity": { "type": "string", "maxLength": 1000, "minLength": 2, "pattern": "^[^<>]*$", "description": "The same field as `subject`, under the name the read side uses. Send one of the two." }, "cost": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "Net cost amount (no VAT), a whole number in the currency's main unit (cents are not stored).", "examples": [ 15000 ] }, "cost_invoiceable": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647, "description": "Net amount to bill on to the client, a whole number (omit if not billed). It counts towards billing only while the cost is not excluded from the summary.", "examples": [ 15000 ] }, "currency_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Currency id from the Flowyer currency list (not an ISO code). Omit it to use the office currency (GET /me `office.currency_id` / `office.currency`); an unknown id answers 422 with the accepted ids and codes in details.allowed." }, "responsible_user_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Responsible colleague: a user id from colleagues.list (look a dictated name up there). Default: the user behind the key." }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "matter_id", "date", "cost" ], "anyOf": [ { "required": [ "subject" ] }, { "required": [ "activity" ] } ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Cost id." }, "matter_id": { "type": [ "integer", "null" ], "description": "Matter the cost belongs to." }, "date": { "type": [ "string", "null" ], "format": "date" }, "activity": { "type": [ "string", "null" ], "description": "Description of the cost (plain text)." }, "cost": { "type": [ "number", "null" ], "description": "Net cost amount (no VAT)." }, "cost_invoiceable": { "type": [ "number", "null" ], "description": "Net amount to bill on to the client. It counts towards billing only while excluded is false." }, "currency_id": { "type": [ "integer", "null" ], "description": "Currency id (Flowyer currency list)." }, "currency": { "type": [ "string", "null" ], "description": "Currency ISO code, e.g. HUF, EUR." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ] }, "excluded": { "type": "boolean", "description": "True when a colleague excluded the cost from the matter summary: it is not billed and is left out of the billable totals." }, "locked": { "type": "boolean", "description": "True when the cost is managed by Flowyer - mirrored from an incoming invoice, or a disbursement surcharge - and cannot be changed through the API (costs.update answers 409 record_locked, details.reason says which)." }, "approved_for_billing": { "type": "boolean", "description": "True when a colleague approved the cost for billing in the matter summary. It stays editable through the API (as in the web), and the approval is NOT re-requested afterwards: say so before changing the amount of an approved cost." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Send this back as expected_updated_at when updating." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/costs", "args": { "matter_id": "body", "date": "body", "subject": "body", "activity": "body", "cost": "body", "cost_invoiceable": "body", "currency_id": "body", "responsible_user_id": "body", "idempotency_key": "idempotency-header" } } }, { "name": "costs_update", "capability": "costs.update", "title": "Update cost", "description": "Changes a live cost: text (`subject`, read back as `activity`), date, net amounts, currency and the responsible colleague. A cost flagged locked: true cannot be changed (409 record_locked, details.reason). Pass expected_updated_at; a conflicting change answers 409.", "scope": "costs:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "date": { "type": [ "string", "null" ], "format": "date", "description": "Date of the cost, YYYY-MM-DD. null keeps the current date." }, "subject": { "type": [ "string", "null" ], "minLength": 1, "description": "Description of the cost, the value the read side returns as `activity` (either name is accepted; null under one of them is \"not given\", only two different texts are refused). Plain text, at most 1000 characters as a NEW value; \"<\" and \">\" cannot be introduced either, but a stored text that is longer or contains them may be sent back unchanged. null keeps the current text." }, "activity": { "type": [ "string", "null" ], "minLength": 1, "description": "The same field as `subject`, under the name the read side uses. Send one of the two (null under the other one is fine)." }, "cost": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647, "description": "Net cost amount (no VAT), a whole number in the currency's main unit (cents are not stored). null clears the amount." }, "cost_invoiceable": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647, "description": "Net amount to bill on to the client, a whole number; null clears it. It counts towards billing only while the cost is not excluded from the summary (excluded is false)." }, "currency_id": { "type": [ "integer", "null" ], "minimum": 0, "description": "Currency id from the Flowyer currency list (not an ISO code; the office currency is GET /me `office.currency_id`). An unknown id answers 422 with the accepted ids and codes in details.allowed. null - or the 0 an unset legacy cost reads back as - keeps the current currency." }, "responsible_user_id": { "type": [ "integer", "null" ], "minimum": 0, "description": "New responsible colleague: an active colleague's user id from colleagues.list. Sending the current one - or null / 0, which a cost without a responsible reads back as - changes nothing." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Cost id." }, "matter_id": { "type": [ "integer", "null" ], "description": "Matter the cost belongs to." }, "date": { "type": [ "string", "null" ], "format": "date" }, "activity": { "type": [ "string", "null" ], "description": "Description of the cost (plain text)." }, "cost": { "type": [ "number", "null" ], "description": "Net cost amount (no VAT)." }, "cost_invoiceable": { "type": [ "number", "null" ], "description": "Net amount to bill on to the client. It counts towards billing only while excluded is false." }, "currency_id": { "type": [ "integer", "null" ], "description": "Currency id (Flowyer currency list)." }, "currency": { "type": [ "string", "null" ], "description": "Currency ISO code, e.g. HUF, EUR." }, "responsible_user_id": { "type": [ "integer", "null" ] }, "responsible": { "type": [ "string", "null" ] }, "excluded": { "type": "boolean", "description": "True when a colleague excluded the cost from the matter summary: it is not billed and is left out of the billable totals." }, "locked": { "type": "boolean", "description": "True when the cost is managed by Flowyer - mirrored from an incoming invoice, or a disbursement surcharge - and cannot be changed through the API (costs.update answers 409 record_locked, details.reason says which)." }, "approved_for_billing": { "type": "boolean", "description": "True when a colleague approved the cost for billing in the matter summary. It stays editable through the API (as in the web), and the approval is NOT re-requested afterwards: say so before changing the amount of an approved cost." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Send this back as expected_updated_at when updating." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/costs/{id}", "args": { "id": "path", "expected_updated_at": "body", "date": "body", "subject": "body", "activity": "body", "cost": "body", "cost_invoiceable": "body", "currency_id": "body", "responsible_user_id": "body" } } }, { "name": "invoices_list", "capability": "invoices.list", "title": "List invoices", "description": "Lists invoices (issued and received), newest issue date first. direction=outgoing is the office's issued-invoice list and leaves proformas out (direction=proforma lists those). Read-only: invoices cannot be created or changed through the API. Invoices of matters the user may not see are hidden. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "invoices:read", "input_schema": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "incoming", "outgoing", "proforma" ], "description": "The office's own three lists: outgoing = invoices issued by the office, proformas excluded (a legacy row with no document type counts as an invoice, as in the office dashboard); proforma = payment requests (díjbekérő) issued by the office; incoming = received." }, "paid_status": { "type": "string", "enum": [ "unpaid", "paid", "partially_paid", "cancelled" ] }, "client_id": { "type": "integer", "minimum": 1 }, "matter_id": { "type": "integer", "minimum": 1 }, "issued_from": { "type": "string", "format": "date", "description": "Issue date on or after.", "examples": [ "2026-01-01" ] }, "issued_to": { "type": "string", "format": "date", "description": "Issue date on or before.", "examples": [ "2026-12-31" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 301 ] }, "invoice_number": { "type": [ "string", "null" ], "examples": [ "FLW-2026-0042" ] }, "direction": { "type": [ "string", "null" ], "enum": [ "incoming", "outgoing", null ], "description": "outgoing = issued by the office, incoming = received by the office." }, "document_type": { "type": [ "string", "null" ], "enum": [ "invoice", "proforma", "receipt", null ], "description": "\"proforma\" is a request for payment, not an issued invoice: it is not revenue and must not be counted with the issued ones. invoices.list direction=outgoing leaves proformas out, direction=proforma lists them. Null on a legacy row, which counts as an invoice." }, "source": { "type": [ "string", "null" ], "enum": [ "manual", "szamlazz_outgoing", "szamlazz_imported", null ] }, "paid_status": { "type": [ "string", "null" ], "enum": [ "unpaid", "paid", "partially_paid", "cancelled", null ] }, "issued_date": { "type": [ "string", "null" ], "format": "date" }, "due_date": { "type": [ "string", "null" ], "format": "date" }, "paid_date": { "type": [ "string", "null" ], "format": "date" }, "completion_date": { "type": [ "string", "null" ], "format": "date" }, "net_amount": { "type": [ "number", "null" ] }, "gross_amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ], "examples": [ "HUF" ] }, "payment_method_id": { "type": [ "integer", "null" ] }, "payment_method": { "type": [ "string", "null" ], "description": "Localized name of the payment method (e.g. bank transfer); English when the office language has no translation for it, null when the method has no name at all. Identify the method by payment_method_id." }, "supplier": { "type": [ "string", "null" ], "description": "Issuer of an incoming invoice." }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false }, "matter_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/invoices", "args": { "direction": "query", "paid_status": "query", "client_id": "query", "matter_id": "query", "issued_from": "query", "issued_to": "query", "limit": "query", "offset": "query" } } }, { "name": "invoices_get", "capability": "invoices.get", "title": "Get invoice", "description": "Returns one invoice. Read-only. Answers 404 when it does not exist or belongs to a matter the user may not see.", "scope": "invoices:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Invoice id.", "examples": [ 301 ] } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 301 ] }, "invoice_number": { "type": [ "string", "null" ], "examples": [ "FLW-2026-0042" ] }, "direction": { "type": [ "string", "null" ], "enum": [ "incoming", "outgoing", null ], "description": "outgoing = issued by the office, incoming = received by the office." }, "document_type": { "type": [ "string", "null" ], "enum": [ "invoice", "proforma", "receipt", null ], "description": "\"proforma\" is a request for payment, not an issued invoice: it is not revenue and must not be counted with the issued ones. invoices.list direction=outgoing leaves proformas out, direction=proforma lists them. Null on a legacy row, which counts as an invoice." }, "source": { "type": [ "string", "null" ], "enum": [ "manual", "szamlazz_outgoing", "szamlazz_imported", null ] }, "paid_status": { "type": [ "string", "null" ], "enum": [ "unpaid", "paid", "partially_paid", "cancelled", null ] }, "issued_date": { "type": [ "string", "null" ], "format": "date" }, "due_date": { "type": [ "string", "null" ], "format": "date" }, "paid_date": { "type": [ "string", "null" ], "format": "date" }, "completion_date": { "type": [ "string", "null" ], "format": "date" }, "net_amount": { "type": [ "number", "null" ] }, "gross_amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ], "examples": [ "HUF" ] }, "payment_method_id": { "type": [ "integer", "null" ] }, "payment_method": { "type": [ "string", "null" ], "description": "Localized name of the payment method (e.g. bank transfer); English when the office language has no translation for it, null when the method has no name at all. Identify the method by payment_method_id." }, "supplier": { "type": [ "string", "null" ], "description": "Issuer of an incoming invoice." }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "additionalProperties": false }, "matter_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "notes": { "type": [ "string", "null" ] }, "received_date": { "type": [ "string", "null" ], "format": "date" }, "sent_date": { "type": [ "string", "null" ], "format": "date" }, "proforma_invoice_id": { "type": [ "integer", "null" ] } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/invoices/{id}", "args": { "id": "path" } } }, { "name": "documents_list", "capability": "documents.list", "title": "List matter documents", "description": "Lists the current versions of the documents filed under a matter: names, sizes, folders and who uploaded them. Metadata only; use documents.download (scope documents:download) for a signed link to the contents. Named documents come first, alphabetically, then imported ones that carry no name. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "documents:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter id.", "examples": [ 1234 ] }, "q": { "type": "string", "maxLength": 100, "description": "Filter by file name.", "examples": [ "contract" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string", "description": "File name as shown in Flowyer: the name stored with the document, or its storage name when it was imported from an older system without one. documents.list is ordered by the stored name: documents that have one come first, alphabetically, then the imported ones without a stored name, oldest first (the order they were filed in Flowyer), which are therefore not sorted by the name shown here. The order is the same on every page, so limit and offset page through the list without repeats or gaps.", "examples": [ "Contract_v2.docx" ] }, "size": { "type": [ "integer", "null" ], "description": "Bytes." }, "version": { "type": "integer", "description": "Current version number of the file." }, "folder": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string", "description": "Folder path inside the matter, \"/\" separated." } }, "additionalProperties": false, "description": "The folder the document is filed in, or null at the matter root. documents.upload.complete answers null when the folder chosen at documents.upload.init was deleted while the bytes were uploading: the document is then filed at the matter root, which is where Flowyer shows it. If the root already holds a document of that name, the upload is filed under a suffixed name (\"Contract_2.pdf\") instead of becoming a new version of that unrelated document; the 201 echoes the stored `name`." }, "folder_deleted": { "type": "boolean", "description": "True when the document is filed in a folder that no longer exists, which Flowyer's own file list does not show (`folder` is null for it, as it is for a document at the matter root). documents.upload.complete answers true only if the folder was deleted while the bytes were uploading AND moving the stored file to the matter root failed: the document is then kept in the deleted folder, where its contents are still reachable. False for everything else, a normal root filing included." }, "created_by_user_id": { "type": [ "integer", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/matters/{id}/documents", "args": { "id": "path", "q": "query", "limit": "query", "offset": "query" } } }, { "name": "documents_folders", "capability": "documents.folders", "title": "List matter folders", "description": "Lists every folder of a matter, empty ones included: id, name, parent_id and the \"/\"-separated path, ordered by path. Pass a folder id as folder_id to documents.upload.init. Answers 404 when the matter is not visible to the user. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "documents:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter id.", "examples": [ 1234 ] }, "q": { "type": "string", "maxLength": 100, "description": "Only folders whose path contains this text (case and accents ignored), e.g. a folder name.", "examples": [ "Beadványok" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Folder id: pass it as folder_id to documents.upload.init." }, "name": { "type": "string", "description": "Folder name as shown in Flowyer." }, "parent_id": { "type": [ "integer", "null" ], "description": "Id of the parent folder; null for a folder at the matter root." }, "path": { "type": "string", "description": "Folder path inside the matter, \"/\" separated, e.g. \"/Iratok/Beadványok\" (the same path documents.list shows for a file's folder)." }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Pass this to documents.folders.rename as expected_updated_at." } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/matters/{id}/folders", "args": { "id": "path", "q": "query", "limit": "query", "offset": "query" } } }, { "name": "documents_folders_create", "capability": "documents.folders.create", "title": "Create matter folder", "description": "Creates a folder in a matter, at the root or under parent_id (a folder of the SAME matter). The name is plain text (\"<\" and \">\" are not allowed). File a document into it by passing the returned id as folder_id to documents.upload.init. Answers 404 when the matter is not visible.", "scope": "documents:create", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter the folder belongs to (must be visible).", "examples": [ 1234 ] }, "name": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^<>]*$", "description": "Folder name, at most 255 characters. Plain text; \"<\" and \">\" are not allowed.", "examples": [ "Beadványok" ] }, "parent_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Parent folder id (from documents.folders) inside the SAME matter; omit for a folder at the matter root." }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "id", "name" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Folder id: pass it as folder_id to documents.upload.init, or as parent_id to documents.folders.create." }, "name": { "type": "string", "description": "Folder name as shown in Flowyer." }, "parent_id": { "type": [ "integer", "null" ], "description": "Id of the parent folder; null for a folder at the matter root." }, "path": { "type": "string", "description": "Folder path inside the matter, \"/\" separated, e.g. \"/Iratok/Beadványok\"." }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Pass this to documents.folders.rename as expected_updated_at." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/matters/{id}/folders", "args": { "id": "path", "name": "body", "parent_id": "body", "idempotency_key": "idempotency-header" } } }, { "name": "documents_upload_init", "capability": "documents.upload.init", "title": "Start document upload", "description": "Starts a document upload: returns a signed upload_url and an upload_token. PUT the bytes there, then call documents.upload.complete. The PUT is a plain HTTPS request outside this API and outside MCP tools: an assistant without its own HTTP client should ask the user to upload the file in Flowyer.", "scope": "documents:create", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter the document belongs to (must be visible)." }, "filename": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^<>]*$", "description": "File name with extension, e.g. \"Contract.pdf\". Plain text; \"<\" and \">\" are not allowed. Executable and web file types are refused (422 blocked_file_type).", "examples": [ "Contract.pdf" ] }, "content_type": { "type": "string", "maxLength": 100, "minLength": 1, "description": "MIME type sent on the PUT, e.g. \"application/pdf\". It is part of the signature and must match exactly.", "examples": [ "application/pdf" ] }, "size": { "type": "integer", "minimum": 1, "description": "File size in bytes, at most 104857600 (the upload limit); a larger size answers 413 `file_too_large`.", "examples": [ 248000 ] }, "folder_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Folder inside the matter: a folder id from documents.folders (it lists empty folders too). Omit for the matter root." } }, "additionalProperties": false, "required": [ "id", "filename", "content_type", "size" ] }, "output_schema": { "type": "object", "properties": { "upload_url": { "type": "string", "description": "Signed URL. PUT the file bytes here with the given content type AND the if_generation_match header below: a plain HTTPS request made by your own HTTP client (no API or MCP tool sends it)." }, "upload_token": { "type": "string", "description": "Pass this to documents.upload.complete after the PUT succeeds." }, "content_type": { "type": "string", "description": "Send exactly this Content-Type on the PUT." }, "if_generation_match": { "type": "string", "description": "Send this value as the \"x-goog-if-generation-match\" header on the PUT (always \"0\"). It makes the upload single-use: the PUT is accepted only while the object does not yet exist, so the signed URL cannot overwrite an already-filed document." }, "object_key": { "type": "string", "description": "Internal storage name (for reference)." }, "expires_in": { "type": "integer", "description": "Seconds until the upload URL and token expire." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "POST", "path": "/matters/{id}/documents/uploads", "args": { "id": "path", "filename": "body", "content_type": "body", "size": "body", "folder_id": "body" } } }, { "name": "documents_upload_complete", "capability": "documents.upload.complete", "title": "Finish document upload", "description": "Finishes a document upload: after the bytes were PUT to the upload_url, records the file on the matter as a new version. Pass the upload_token from documents.upload.init. The file metadata is taken from the token, not from this request. A folder deleted meanwhile files the document at the root.", "scope": "documents:create", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter the document belongs to (same as in init)." }, "upload_token": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "The token returned by documents.upload.init." }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "id", "upload_token" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string", "description": "File name as shown in Flowyer: the name stored with the document, or its storage name when it was imported from an older system without one. documents.list is ordered by the stored name: documents that have one come first, alphabetically, then the imported ones without a stored name, oldest first (the order they were filed in Flowyer), which are therefore not sorted by the name shown here. The order is the same on every page, so limit and offset page through the list without repeats or gaps.", "examples": [ "Contract_v2.docx" ] }, "size": { "type": [ "integer", "null" ], "description": "Bytes." }, "version": { "type": "integer", "description": "Current version number of the file." }, "folder": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string", "description": "Folder path inside the matter, \"/\" separated." } }, "additionalProperties": false, "description": "The folder the document is filed in, or null at the matter root. documents.upload.complete answers null when the folder chosen at documents.upload.init was deleted while the bytes were uploading: the document is then filed at the matter root, which is where Flowyer shows it. If the root already holds a document of that name, the upload is filed under a suffixed name (\"Contract_2.pdf\") instead of becoming a new version of that unrelated document; the 201 echoes the stored `name`." }, "folder_deleted": { "type": "boolean", "description": "True when the document is filed in a folder that no longer exists, which Flowyer's own file list does not show (`folder` is null for it, as it is for a document at the matter root). documents.upload.complete answers true only if the folder was deleted while the bytes were uploading AND moving the stored file to the matter root failed: the document is then kept in the deleted folder, where its contents are still reachable. False for everything else, a normal root filing included." }, "created_by_user_id": { "type": [ "integer", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/matters/{id}/documents", "args": { "id": "path", "upload_token": "body", "idempotency_key": "idempotency-header" } } }, { "name": "documents_download", "capability": "documents.download", "title": "Download document", "description": "Returns a short-lived signed URL to download one document by id, if its matter is visible. GET the url to fetch the bytes; it expires in a few minutes.", "scope": "documents:download", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Document id (from documents.list)." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "download_url": { "type": "string", "description": "Signed URL. GET it to download the file bytes." }, "filename": { "type": "string", "description": "File name for the download." }, "size": { "type": [ "integer", "null" ], "description": "Bytes." }, "expires_in": { "type": "integer", "description": "Seconds until the URL expires." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/documents/{id}/download", "args": { "id": "path" } } }, { "name": "documents_rename", "capability": "documents.rename", "title": "Rename document", "description": "Renames a document (its display name only; the file content is unchanged). The new name must be unique in the same folder of the matter. Pass expected_updated_at from your last read; a conflicting change answers 409.", "scope": "documents:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "name": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^<>]*$", "description": "New file name, at most 255 characters INCLUDING the extension. The current extension is kept if you omit one, and it counts towards the 255 (so an extension-less name for \"Beadvany.pdf\" may be at most 251 characters). Plain text; \"<\" and \">\" are not allowed, so a document whose stored name contains one can only be renamed in Flowyer.", "examples": [ "Contract_signed.pdf" ] } }, "additionalProperties": false, "required": [ "id", "name" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string", "description": "File name as shown in Flowyer: the name stored with the document, or its storage name when it was imported from an older system without one. documents.list is ordered by the stored name: documents that have one come first, alphabetically, then the imported ones without a stored name, oldest first (the order they were filed in Flowyer), which are therefore not sorted by the name shown here. The order is the same on every page, so limit and offset page through the list without repeats or gaps.", "examples": [ "Contract_v2.docx" ] }, "size": { "type": [ "integer", "null" ], "description": "Bytes." }, "version": { "type": "integer", "description": "Current version number of the file." }, "folder": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string", "description": "Folder path inside the matter, \"/\" separated." } }, "additionalProperties": false, "description": "The folder the document is filed in, or null at the matter root. documents.upload.complete answers null when the folder chosen at documents.upload.init was deleted while the bytes were uploading: the document is then filed at the matter root, which is where Flowyer shows it. If the root already holds a document of that name, the upload is filed under a suffixed name (\"Contract_2.pdf\") instead of becoming a new version of that unrelated document; the 201 echoes the stored `name`." }, "folder_deleted": { "type": "boolean", "description": "True when the document is filed in a folder that no longer exists, which Flowyer's own file list does not show (`folder` is null for it, as it is for a document at the matter root). documents.upload.complete answers true only if the folder was deleted while the bytes were uploading AND moving the stored file to the matter root failed: the document is then kept in the deleted folder, where its contents are still reachable. False for everything else, a normal root filing included." }, "created_by_user_id": { "type": [ "integer", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/documents/{id}", "args": { "id": "path", "expected_updated_at": "body", "name": "body" } } }, { "name": "documents_folders_rename", "capability": "documents.folders.rename", "title": "Rename matter folder", "description": "Renames a folder (its name only; its files and subfolders keep their place). The name is plain text (\"<\" and \">\" are not allowed). Pass expected_updated_at from your last read (documents.folders lists it); a conflicting change answers 409.", "scope": "documents:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "name": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^<>]*$", "description": "New folder name, at most 255 characters. Plain text; \"<\" and \">\" are not allowed.", "examples": [ "Beadványok" ] } }, "additionalProperties": false, "required": [ "id", "name" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Folder id: pass it as folder_id to documents.upload.init, or as parent_id to documents.folders.create." }, "name": { "type": "string", "description": "Folder name as shown in Flowyer." }, "parent_id": { "type": [ "integer", "null" ], "description": "Id of the parent folder; null for a folder at the matter root." }, "path": { "type": "string", "description": "Folder path inside the matter, \"/\" separated, e.g. \"/Iratok/Beadványok\"." }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Pass this to documents.folders.rename as expected_updated_at." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/folders/{id}", "args": { "id": "path", "expected_updated_at": "body", "name": "body" } } }, { "name": "knowledge_articles_list", "capability": "knowledge.articles.list", "title": "List knowledge base articles", "description": "Lists knowledge-base articles the user may see (the author's own, global articles, and articles shared with the user's role). All statuses by default; filter by status, or pass `q` to full-text search titles, excerpts, content and tags. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "knowledge:read", "input_schema": { "type": "object", "properties": { "q": { "type": [ "string", "null" ], "maxLength": 255, "description": "Full-text search term (titles, excerpts, content and tag names). Boolean operators are stripped.", "examples": [ "felmondási idő" ] }, "status": { "type": [ "string", "null" ], "enum": [ "draft", "published", "archived", null ], "description": "Only articles with this status. Omit to list every status." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "slug": { "type": "string", "description": "Server-generated URL slug.", "examples": [ "felmondasi-ido" ] }, "title": { "type": "string", "examples": [ "Felmondási idő a munka törvénykönyvében" ] }, "excerpt": { "type": [ "string", "null" ], "description": "Short summary (rich HTML, as stored). Use knowledge.articles.get for the full body." }, "status": { "type": "string", "enum": [ "draft", "published", "archived" ] }, "is_featured": { "type": "boolean", "description": "Whether the article is pinned to the KB home page (not settable through the API)." }, "category_id": { "type": [ "integer", "null" ] }, "category_name": { "type": [ "string", "null" ] }, "author_id": { "type": "integer", "description": "User id of the author; 0 for a global (default) article." }, "author_name": { "type": [ "string", "null" ] }, "editor_id": { "type": [ "integer", "null" ], "description": "User id of the last editor, or null if never edited." }, "editor_name": { "type": [ "string", "null" ] }, "views_count": { "type": "integer" }, "downloads_count": { "type": "integer" }, "shared_roles": { "type": "array", "items": { "type": "integer" }, "description": "Role ids the article is shared with (empty = only the author/global)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tag names on the article." }, "published_at": { "type": [ "string", "null" ], "format": "date-time", "description": "When the article was first published, or null." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/knowledge/articles", "args": { "q": "query", "status": "query", "limit": "query", "offset": "query" } } }, { "name": "knowledge_articles_get", "capability": "knowledge.articles.get", "title": "Get knowledge base article", "description": "Returns one knowledge-base article, including its full content, tags and shared roles. Answers 404 when the article does not exist or the user may not see it.", "scope": "knowledge:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Article id.", "examples": [ 9876 ] } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "slug": { "type": "string", "description": "Server-generated URL slug.", "examples": [ "felmondasi-ido" ] }, "title": { "type": "string", "examples": [ "Felmondási idő a munka törvénykönyvében" ] }, "excerpt": { "type": [ "string", "null" ], "description": "Short summary (rich HTML, as stored). Use knowledge.articles.get for the full body." }, "status": { "type": "string", "enum": [ "draft", "published", "archived" ] }, "is_featured": { "type": "boolean", "description": "Whether the article is pinned to the KB home page (not settable through the API)." }, "category_id": { "type": [ "integer", "null" ] }, "category_name": { "type": [ "string", "null" ] }, "author_id": { "type": "integer", "description": "User id of the author; 0 for a global (default) article." }, "author_name": { "type": [ "string", "null" ] }, "editor_id": { "type": [ "integer", "null" ], "description": "User id of the last editor, or null if never edited." }, "editor_name": { "type": [ "string", "null" ] }, "views_count": { "type": "integer" }, "downloads_count": { "type": "integer" }, "shared_roles": { "type": "array", "items": { "type": "integer" }, "description": "Role ids the article is shared with (empty = only the author/global)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tag names on the article." }, "published_at": { "type": [ "string", "null" ], "format": "date-time", "description": "When the article was first published, or null." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "content": { "type": "string", "description": "The full article body as stored (rich HTML)." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/knowledge/articles/{id}", "args": { "id": "path" } } }, { "name": "knowledge_articles_create", "capability": "knowledge.articles.create", "title": "Create knowledge base article", "description": "Creates a knowledge-base article authored by the key's user. The slug is generated from the title. The category must exist and be active. Share it with roles via `shared_roles` (otherwise only the author sees it). `content` and `excerpt` are HTML and are sanitised server-side.", "scope": "knowledge:create", "input_schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 500, "description": "Article title. Plain text.", "examples": [ "Felmondási idő a munka törvénykönyvében" ] }, "excerpt": { "type": [ "string", "null" ], "description": "Short summary (HTML allowed, sanitised server-side), at most 200 characters." }, "content": { "type": "string", "description": "The article body. Rich HTML, sanitised server-side with the knowledge-base profile." }, "category_id": { "type": "integer", "minimum": 1, "description": "Id of an existing, active knowledge-base category.", "examples": [ 12 ] }, "status": { "type": "string", "enum": [ "draft", "published", "archived" ], "description": "draft, published or archived. published stamps published_at." }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 100 }, "description": "Tag names; new tags are created as needed." }, "shared_roles": { "type": [ "array", "null" ], "items": { "type": "integer", "minimum": 1 }, "description": "Role ids to share the article with. Empty means only the author can see it." }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "title", "content", "category_id", "status" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "slug": { "type": "string", "description": "Server-generated URL slug.", "examples": [ "felmondasi-ido" ] }, "title": { "type": "string", "examples": [ "Felmondási idő a munka törvénykönyvében" ] }, "excerpt": { "type": [ "string", "null" ], "description": "Short summary (rich HTML, as stored). Use knowledge.articles.get for the full body." }, "status": { "type": "string", "enum": [ "draft", "published", "archived" ] }, "is_featured": { "type": "boolean", "description": "Whether the article is pinned to the KB home page (not settable through the API)." }, "category_id": { "type": [ "integer", "null" ] }, "category_name": { "type": [ "string", "null" ] }, "author_id": { "type": "integer", "description": "User id of the author; 0 for a global (default) article." }, "author_name": { "type": [ "string", "null" ] }, "editor_id": { "type": [ "integer", "null" ], "description": "User id of the last editor, or null if never edited." }, "editor_name": { "type": [ "string", "null" ] }, "views_count": { "type": "integer" }, "downloads_count": { "type": "integer" }, "shared_roles": { "type": "array", "items": { "type": "integer" }, "description": "Role ids the article is shared with (empty = only the author/global)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tag names on the article." }, "published_at": { "type": [ "string", "null" ], "format": "date-time", "description": "When the article was first published, or null." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "content": { "type": "string", "description": "The full article body as stored (rich HTML)." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/knowledge/articles", "args": { "title": "body", "excerpt": "body", "content": "body", "category_id": "body", "status": "body", "tags": "body", "shared_roles": "body", "idempotency_key": "idempotency-header" } } }, { "name": "knowledge_articles_update", "capability": "knowledge.articles.update", "title": "Update knowledge base article", "description": "Changes a knowledge-base article: title (the slug is re-derived), excerpt, content, category, status, tags or shared roles. Only the author (or anyone, for a global article) may edit. Pass expected_updated_at; a conflicting change answers 409. content and excerpt are sanitised server-side.", "scope": "knowledge:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "title": { "type": [ "string", "null" ], "description": "Article title (plain text). null keeps the current title; a new title re-derives the slug." }, "excerpt": { "type": [ "string", "null" ], "description": "Short summary (HTML allowed, sanitised), at most 200 characters as a NEW value. Empty/null clears it; omit to keep it." }, "content": { "type": [ "string", "null" ], "description": "The article body (rich HTML, sanitised). null keeps the current content; it cannot be cleared." }, "category_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Move the article to this existing, active category. null keeps the current one." }, "status": { "type": [ "string", "null" ], "enum": [ "draft", "published", "archived", null ], "description": "draft, published or archived. The first switch to published stamps published_at; it is never cleared. null keeps the current status." }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 100 }, "description": "Replaces the whole tag set (new tags are created). An empty array clears all tags; omit to keep them." }, "shared_roles": { "type": [ "array", "null" ], "items": { "type": "integer", "minimum": 1 }, "description": "Replaces the whole shared-role set. An empty array removes all sharing (only the author sees it); omit to keep it." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 9876 ] }, "slug": { "type": "string", "description": "Server-generated URL slug.", "examples": [ "felmondasi-ido" ] }, "title": { "type": "string", "examples": [ "Felmondási idő a munka törvénykönyvében" ] }, "excerpt": { "type": [ "string", "null" ], "description": "Short summary (rich HTML, as stored). Use knowledge.articles.get for the full body." }, "status": { "type": "string", "enum": [ "draft", "published", "archived" ] }, "is_featured": { "type": "boolean", "description": "Whether the article is pinned to the KB home page (not settable through the API)." }, "category_id": { "type": [ "integer", "null" ] }, "category_name": { "type": [ "string", "null" ] }, "author_id": { "type": "integer", "description": "User id of the author; 0 for a global (default) article." }, "author_name": { "type": [ "string", "null" ] }, "editor_id": { "type": [ "integer", "null" ], "description": "User id of the last editor, or null if never edited." }, "editor_name": { "type": [ "string", "null" ] }, "views_count": { "type": "integer" }, "downloads_count": { "type": "integer" }, "shared_roles": { "type": "array", "items": { "type": "integer" }, "description": "Role ids the article is shared with (empty = only the author/global)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tag names on the article." }, "published_at": { "type": [ "string", "null" ], "format": "date-time", "description": "When the article was first published, or null." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "content": { "type": "string", "description": "The full article body as stored (rich HTML)." } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/knowledge/articles/{id}", "args": { "id": "path", "expected_updated_at": "body", "title": "body", "excerpt": "body", "content": "body", "category_id": "body", "status": "body", "tags": "body", "shared_roles": "body" } } }, { "name": "knowledge_categories_list", "capability": "knowledge.categories.list", "title": "List knowledge base categories", "description": "Lists the knowledge base categories the user may see: built-in default categories, the user's own, and those shared with the user's role. Ordered as in Flowyer (sort position, then name). Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "knowledge:read", "input_schema": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 42 ] }, "slug": { "type": "string", "description": "URL slug, generated from the name.", "examples": [ "munkajog" ] }, "name": { "type": "string", "examples": [ "Munkajog" ] }, "description": { "type": [ "string", "null" ], "description": "Plain-text description, or null." }, "icon": { "type": [ "string", "null" ], "description": "Icon identifier shown next to the category, or null." }, "order_column": { "type": "integer", "description": "Sort position among sibling categories.", "examples": [ 0 ] }, "is_active": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ], "description": "Parent category id, or null for a root category." }, "author_id": { "type": "integer", "description": "User id of the creator; 0 for a built-in default category visible to everyone." }, "author_name": { "type": [ "string", "null" ], "description": "Display name of the creator, or null for a default category." }, "articles_count": { "type": "integer", "description": "Number of published articles in this category that the caller may see." }, "shared_roles": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "description": "Role ids this category is shared with. Empty means only the author sees it (a default category with author_id 0 is visible to everyone)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/knowledge/categories", "args": { "limit": "query", "offset": "query" } } }, { "name": "knowledge_categories_get", "capability": "knowledge.categories.get", "title": "Get knowledge base category", "description": "Returns one knowledge base category. Answers 404 when the category does not exist or is not visible to the user who owns this API key.", "scope": "knowledge:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Category id.", "examples": [ 42 ] } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 42 ] }, "slug": { "type": "string", "description": "URL slug, generated from the name.", "examples": [ "munkajog" ] }, "name": { "type": "string", "examples": [ "Munkajog" ] }, "description": { "type": [ "string", "null" ], "description": "Plain-text description, or null." }, "icon": { "type": [ "string", "null" ], "description": "Icon identifier shown next to the category, or null." }, "order_column": { "type": "integer", "description": "Sort position among sibling categories.", "examples": [ 0 ] }, "is_active": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ], "description": "Parent category id, or null for a root category." }, "author_id": { "type": "integer", "description": "User id of the creator; 0 for a built-in default category visible to everyone." }, "author_name": { "type": [ "string", "null" ], "description": "Display name of the creator, or null for a default category." }, "articles_count": { "type": "integer", "description": "Number of published articles in this category that the caller may see." }, "shared_roles": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "description": "Role ids this category is shared with. Empty means only the author sees it (a default category with author_id 0 is visible to everyone)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/knowledge/categories/{id}", "args": { "id": "path" } } }, { "name": "knowledge_categories_create", "capability": "knowledge.categories.create", "title": "Create knowledge base category", "description": "Creates a knowledge base category. The URL slug is generated from the name. Share it with roles via shared_roles, or omit them so only you (the author) can see it. A parent_id, when given, must be an existing active category.", "scope": "knowledge:create", "input_schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "pattern": "^[^<>]*$", "description": "Category name. Plain text; \"<\" and \">\" are not allowed.", "examples": [ "Munkajog" ] }, "description": { "type": [ "string", "null" ], "description": "Optional description, plain text." }, "parent_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Parent category id (must exist and be active). Omit for a root category." }, "icon": { "type": [ "string", "null" ], "maxLength": 100, "pattern": "^[^<>]*$", "description": "Optional icon identifier. Plain text; \"<\" and \">\" are not allowed." }, "is_active": { "type": [ "boolean", "null" ], "description": "Whether the category is active. Default true.", "default": true }, "order_column": { "type": [ "integer", "null" ], "minimum": 0, "description": "Sort position among sibling categories. Default 0.", "examples": [ 0 ] }, "shared_roles": { "type": [ "array", "null" ], "items": { "type": "integer", "minimum": 1 }, "description": "Role ids to share this category with. Omit so only you (the author) can see it." }, "idempotency_key": { "type": "string", "maxLength": 128, "pattern": "^[A-Za-z0-9_\\-:.]{1,128}$", "description": "Optional stable key for safe retries: the same value returns the record created the first time instead of creating another; different values always create different records. Without a key, an identical create repeated within 120 seconds returns the first record. Letters, digits, `_`, `-`, `:` or `.`, at most 128 characters.", "examples": [ "b8f1c2e0-6f7a-4d2e-9c1b-2a3d4e5f6a7b" ] } }, "additionalProperties": false, "required": [ "name" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 42 ] }, "slug": { "type": "string", "description": "URL slug, generated from the name.", "examples": [ "munkajog" ] }, "name": { "type": "string", "examples": [ "Munkajog" ] }, "description": { "type": [ "string", "null" ], "description": "Plain-text description, or null." }, "icon": { "type": [ "string", "null" ], "description": "Icon identifier shown next to the category, or null." }, "order_column": { "type": "integer", "description": "Sort position among sibling categories.", "examples": [ 0 ] }, "is_active": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ], "description": "Parent category id, or null for a root category." }, "author_id": { "type": "integer", "description": "User id of the creator; 0 for a built-in default category visible to everyone." }, "author_name": { "type": [ "string", "null" ], "description": "Display name of the creator, or null for a default category." }, "articles_count": { "type": "integer", "description": "Number of published articles in this category that the caller may see." }, "shared_roles": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "description": "Role ids this category is shared with. Empty means only the author sees it (a default category with author_id 0 is visible to everyone)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": false, "idempotent_hint": false }, "x-http": { "method": "POST", "path": "/knowledge/categories", "args": { "name": "body", "description": "body", "parent_id": "body", "icon": "body", "is_active": "body", "order_column": "body", "shared_roles": "body", "idempotency_key": "idempotency-header" } } }, { "name": "knowledge_categories_update", "capability": "knowledge.categories.update", "title": "Update knowledge base category", "description": "Changes a knowledge base category: name (the slug follows), description, icon, parent, active flag, sort position or the roles it is shared with. Only the author may change it (a built-in default category is editable by anyone). Pass expected_updated_at; a conflicting change answers 409.", "scope": "knowledge:update", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Id of the record to modify." }, "expected_updated_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The `updated_at` value from your most recent read of this record (required whenever the record has one). If the record changed since (a colleague edited it), the API answers 409 and you must re-read before retrying. A legacy record whose `updated_at` is null takes null." }, "name": { "type": [ "string", "null" ], "minLength": 1, "description": "Category name. At most 255 characters as a NEW value; \"<\" and \">\" cannot be introduced, but a stored name that is longer or contains them may be sent back unchanged. null keeps the current name." }, "description": { "type": [ "string", "null" ], "description": "Plain-text description. null clears it." }, "parent_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Move the category under this parent (must exist, be active and not create a cycle), or null to make it a root category." }, "icon": { "type": [ "string", "null" ], "description": "Icon identifier. At most 100 characters as a NEW value; \"<\" and \">\" cannot be introduced. null clears it." }, "is_active": { "type": [ "boolean", "null" ], "description": "Active flag. Omit or null to keep the current value." }, "order_column": { "type": [ "integer", "null" ], "minimum": 0, "description": "Sort position among sibling categories. Omit or null to keep the current value." }, "shared_roles": { "type": [ "array", "null" ], "items": { "type": "integer", "minimum": 1 }, "description": "Replace the set of role ids this category is shared with. An empty array removes all sharing (only the author sees it). Omit to leave sharing unchanged." } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 42 ] }, "slug": { "type": "string", "description": "URL slug, generated from the name.", "examples": [ "munkajog" ] }, "name": { "type": "string", "examples": [ "Munkajog" ] }, "description": { "type": [ "string", "null" ], "description": "Plain-text description, or null." }, "icon": { "type": [ "string", "null" ], "description": "Icon identifier shown next to the category, or null." }, "order_column": { "type": "integer", "description": "Sort position among sibling categories.", "examples": [ 0 ] }, "is_active": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ], "description": "Parent category id, or null for a root category." }, "author_id": { "type": "integer", "description": "User id of the creator; 0 for a built-in default category visible to everyone." }, "author_name": { "type": [ "string", "null" ], "description": "Display name of the creator, or null for a default category." }, "articles_count": { "type": "integer", "description": "Number of published articles in this category that the caller may see." }, "shared_roles": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "description": "Role ids this category is shared with. Empty means only the author sees it (a default category with author_id 0 is visible to everyone)." }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false }, "is_list": false, "annotations": { "read_only_hint": false, "destructive_hint": true, "idempotent_hint": false }, "x-http": { "method": "PATCH", "path": "/knowledge/categories/{id}", "args": { "id": "path", "expected_updated_at": "body", "name": "body", "description": "body", "parent_id": "body", "icon": "body", "is_active": "body", "order_column": "body", "shared_roles": "body" } } }, { "name": "emails_list", "capability": "emails.list", "title": "List matter emails", "description": "Lists the emails saved onto a matter: sender name and address, subject, size and the colleague who saved each one, newest sent first. Header and metadata only, never the body or the raw HTML. Use emails.get for a single message's plain-text body. Paginated: pass `limit`/`offset`; the result carries `pagination.total`, use offset + limit for the next page.", "scope": "emails:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Matter id.", "examples": [ 1234 ] }, "q": { "type": "string", "maxLength": 100, "description": "Filter by subject, sender name or sender address (accent- and case-insensitive). Not the body.", "examples": [ "invoice" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, 1-100. Default 25.", "examples": [ 25 ], "default": 25 }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip. Use offset + limit of the previous page to get the next one; `pagination.total` is the full count.", "examples": [ 0 ], "default": 0 } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Email id (use with emails.get).", "examples": [ 1234 ] }, "from_name": { "type": [ "string", "null" ], "description": "Display name of the outside party. The store keeps no direction or recipient columns, so this is always the external party, never a colleague, and the API cannot say whether the mail was incoming or outgoing." }, "from_address": { "type": [ "string", "null" ], "description": "SMTP address of the outside party." }, "subject": { "type": [ "string", "null" ] }, "sent_at": { "type": [ "string", "null" ], "format": "date-time", "description": "When the message was sent. The stored value's timezone is inconsistent by ingest path (the IMAP worker stores UTC, the Outlook add-in stores an office-zone wall time), so it is best-effort and the list order by it can be off by the office UTC offset across sources. created_at is the reliable timestamp." }, "size": { "type": [ "integer", "null" ], "description": "Bytes of the stored .eml/.msg file." }, "extension": { "type": [ "string", "null" ], "description": "\"msg\" (Outlook add-in) or \"eml\" (IMAP / default); null on some legacy rows." }, "saved_by_user_id": { "type": [ "integer", "null" ], "description": "User id of the colleague who saved the mail into Flowyer." }, "saved_by": { "type": [ "string", "null" ], "description": "Display name of that colleague." }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "description": "When the mail was saved into Flowyer (office-zone wall time). The reliable timestamp for stable pagination." } }, "additionalProperties": false }, "is_list": true, "annotations": { "read_only_hint": true, "destructive_hint": false, "idempotent_hint": true }, "x-http": { "method": "GET", "path": "/matters/{id}/emails", "args": { "id": "path", "q": "query", "limit": "query", "offset": "query" } } }, { "name": "emails_get", "capability": "emails.get", "title": "Get email", "description": "Returns one saved email of a matter with its plain-text body (sender, subject, size and who saved it). The raw HTML body is never returned. Answers 404 when the email does not exist or its matter is not visible to the user who owns this API key.", "scope": "emails:read", "input_schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Email id.", "examples": [ 1234 ] } }, "additionalProperties": false, "required": [ "id" ] }, "output_schema": { "type": "object", "properties": { "id": { "type": "integer", "examples": [ 1234 ] }, "matter": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "case_number": { "type": "string" } }, "additionalProperties": false, "description": "The matter the mail is filed under, or null for a caseless mail (saved outside any case)." }, "from_name": { "type": [ "string", "null" ], "description": "Display name of the outside party (never a colleague; the store has no direction column)." }, "from_address": { "type": [ "string", "null" ], "description": "SMTP address of the outside party." }, "subject": { "type": [ "string", "null" ] }, "body": { "type": [ "string", "null" ], "description": "The message body as plain text. The raw HTML body is deliberately never returned (untrusted third-party HTML). Best-effort plain text: if the original HTML carried