Connections, auth and API

How do I get a report ID or field IDs for the API?

Read the report ID from the report's URL, then call the report fields endpoint to get each field's ID and type.

How-to

Short answer: Take the report ID from the report's URL. Then call Retrieve report fields to get the ID and type of every field in that report.

Why it happens

  • Report and field IDs aren't shown as labels in the UI. They appear in URLs and API responses.
  • There's no UI or API that lists every report ID in a process.

How to fix it

To find a report ID:

  1. Open the report.
  2. Copy the value after /report/ in the browser's address bar.
  3. For a report inside an app, open the browser's developer tools and look at the network request the report makes. Its URL holds the process ID and report ID.

To find field IDs:

  1. Create a report that includes the fields you need.
  2. Call GET https://<subdomain>.kissflow.com/process-report/2/{account_id}/{process_id}/{report_id}/fields. It returns each field's ID and type.

To count the items in a report:

  1. Call GET /process-report/2/{account_id}/{process_id}/{report_id}/count.
  2. It works for your own reports as well as the default all items report.

See API and SDK documentation for request details.

Important

The report endpoints return counts, fields and single items. They don't return every row of a report.

Related answers