get_app | Get general information about an app: appId, name, code, description, createdAt, creator, modifiedAt, modifier, spaceId. Argument: app (integer >= 1, the app id). A wrong token or an app the token does not cover is refused by Kintone (400 GAIA_IA02 / 403 GAIA_AP15). Also useful to check the token. |
get_form_fields | Get the fields of an app: for each field code its type (SINGLE_LINE_TEXT, NUMBER, DROP_DOWN, DATE, SUBTABLE…), label and settings (options of a drop-down, required, unique…). Returns { revision, properties }. Call it before add_record / update_record to learn the exact field codes and types. Argument: app (integer >= 1). |
get_form_layout | Get the layout of the form of an app: rows of fields, groups and tables, in display order. Returns { layout, revision }. Argument: app (integer >= 1). |
get_record | Get one record of an app. Arguments: app (integer >= 1), id (integer >= 1, the record id, “$id” / “Record number” of the record). Returns { record: { “<field code>”: { type, value } } }. |
get_status_settings | Get the process management settings of an app: enable (boolean), states (status names, index, assignee) and actions (name, from, to) — the action names that update_record_status expects. Returns { enable, states, actions, revision }. Argument: app (integer >= 1). |
list_comments | List the comments of a record. Arguments: app (integer >= 1), record (integer >= 1, the record id), order (“ASC” | “DESC”, default “DESC”: newest first), offset (integer >= 0, comments to skip), limit (integer 1-10, default and maximum 10). Returns { comments: [{ id, text, createdAt, creator, mentions }], older, newer } (booleans telling whether more comments exist). |
list_records | Query the records of an app (read-only, not a write; sent as POST with X-HTTP-Method-Override: GET). Arguments: app (integer >= 1), query (string, optional, max 10000 characters: Kintone query syntax — conditions like status in ("Won", "New") and amount > 1000 and created_time > TODAY() with operators = != > < >= <= in not in like not like is empty is not empty and or, then optionally order by <field code> asc|desc, limit <1-500> (default 100), offset <0-10000> in this order; empty = all records, newest first), fields (array of field code strings, optional, max 1000: only these fields are returned; use “$id” for the record id), totalCount (boolean, optional: also return the number of matching records). Returns { records: [{ “<field code>”: { type, value } }], totalCount }. |
