Reads
Reads
Every question the API answers, grouped by module. Each read has its contract, its examples in four clients and the reasons it may refuse. Never a table, and never text a client or the team wrote.
Last updated
OAuth only
A read is done on behalf of the person who authorized your app, with their role: it answers with what they can see on their own screen. An API key gets reads_need_a_person. Authentication →
CRM
crm.clients_searchv1Counts and finds the workspace's CRM clients, optionally by part of the name, status, tag or creation date. Returns the total, the total per status and up to 15 clients with status, owner and creation day. No contact details and no notes.crm.month_summary_getv1Reads how the month is going, piece by piece and with the same figures each read would give: new clients, collected, proposals sent and accepted, deals won, appointments and the ledger result. A piece the person's role does not see, or whose read is off, comes back inunavailable.crm.client_overview_getv1Reads where ONE client named by name stands: their open invoices with balance and since when they are owed, the total owed, and which channels you have talked on with the day of their last message. Never what was said, and no phone or email.
Kiipu · invoicing
kiipu.collections_getv1Reads what is owed: the outstanding total, what is overdue by age bucket, the 15 clients who owe the most with their overdue amount and since when, and the next installments due. Changes nothing and contacts no one.kiipu.collected_month_getv1Reads how much was collected this month so far (as the ledger recorded it), the same stretch of last month to compare, and what is still outstanding. Does not say who owes: that is kiipu.collections_get.kiipu.client_invoices_listv1Lists the latest invoices and payments of ONE client named by name: number, status, total, balance, and when and how they paid. With several matches it refuses withambiguousand the candidates; with none,not_found.kiipu.month_result_getv1Reads this month's income statement from the ledger: revenue, expenses, net income, the accounts that weigh most and last month to compare. If the ledger does not balance right now it gives no figures; with no entries it says so, never zero.kiipu.client_balance_getv1Reads how much ONE client named by name owes in total, as the ledger has it, and their next installment due. A client never invoiced comes back asnever_invoiced, never as up to date; a lead or a churned client, asnot_a_client. With several matches it refuses withambiguous; with none,not_found.
Miira · leads & WhatsApp
miira.conversations_waiting_getv1Reads how many conversations a team member is handling, how many are waiting for a reply, how many have waited longer than the workspace threshold and the longest wait. Counts only: no names and no messages.miira.funnel_getv1Reads the Miira lead funnel by stage (the same rule as the board), how many leads are qualified, how many came in this month and the 15 most recent with their stage. Clients who already bought are in the CRM, not here.miira.catalog_searchv1Searches the published catalog by words and returns up to 5 active public offerings with name, summary, price, currency and what the price is per; with exactly one match, also its whole description and attributes. Internal, paused and discontinued offerings never come back.miira.knowledge_searchv1Searches the knowledge base the team loaded for the sales agent (manuals, cases, answers to objections) by words, and returns up to 6 fragments with their document and section. Only active documents that finished indexing. It is not the source of a price: that is miira.catalog_search.miira.agent_config_getv1Reads how the sales agent is configured today: its persona, the script in order with what each question saves and scores, the funnel stages, the reference responses, the documents asked per client type and the milestones. Withconfigured: falsethe workspace still has the demo setup. Changes nothing.