Skip to main content
POST
Client work
Create an access key under Karbon Settings > API Applications, then enter it in the console. OneShot supplies its own application token. List connections with GET /v1/connections and choose connection_id by system and account_label. Every tool accepts connection_id, limit (1 to 100, default 25) and cursor. Each list returns next_cursor (null at the end), and every record includes source: { system: "karbon", id }. Pass next_cursor unchanged with the same connection and filters. A page may contain fewer than limit records, including none, while still having a next_cursor. query matches a partial client name, case insensitively. type defaults to all, which pages through people first, then organizations. Client groups are not included. Client records carry id, name, type, emails, phones, client_manager and client_owner. Contact details are the primary email and phone from Karbon’s summary. Organizations have null manager and owner. Manager and owner values are the user key or email Karbon supplies. Work items carry id, title, client { id, name }, work_type, status, assignee { id, name }, start_date, due_date and deadline. deadline is Karbon’s external DeadlineDate, distinct from the firm’s DueDate. status uses Karbon’s primary status, with Planned and ReadyToStart mapped to planned. It defaults to all. due_before is an inclusive YYYY-MM-DD day; assignee is an email address and work_type is the exact type name. Planned and due-date filters narrow the returned page locally, so keep following next_cursor on empty pages. Time entries carry id, date, user { id, name }, minutes, work_item { id, title }, client { id, name } and billable. Daily entries, not the deprecated weekly timesheet aggregates. billable reflects Karbon’s TaskTypeIsBillable flag, not whether time has been billed. since is an inclusive YYYY-MM-DD day; user takes a user id. Related names and work titles are null when Karbon does not include them. Undisclosed scalar fields are null; absent email and phone values produce empty arrays.
Records are answered inline only, never stored in jobs, receipts, logs, goal decisions, memory or artifacts. Free text is untrusted content. Reads use at most three allowlisted calls. Missing application configuration, malformed input, unsupported cursors, foreign, revoked and expired connections are refused before payment. A refused access key leaves the connection inactive. Failed paid reads return account credit. See pricing.