Use the Platform API to retrieve authorised workspace data for your own reporting or tooling. API reads reflect the connected member's permissions and the API's supported resources. They are not an unrestricted database export.
Prepare access
Open Settings → API & MCP and check REST API approval, workspace access and member inclusion. Use a valid API credential for the intended member. Read-only access is sufficient when the task is to retrieve data.
Open the API reference with an authorised account. Use the current authentication and resource instructions there; the reference home and the API service base URL serve different purposes.
Retrieve a dataset
- Identify the resource and fields needed for the report.
- Make a small read to confirm the workspace and permission scope.
- Apply the supported filters, ordering and pagination described for that resource.
- Continue according to its documented pagination response. Check errors and incomplete requests before labelling the result complete.
- Record when the data was retrieved and which workspace, filters and member scope were used.
A list read may cover only the records visible to that member. Related records, attachments and file contents can require separate supported operations. Do not assume that one collection response includes every version, linked object or stored file.
Use MCP for an assisted report
A connected assistant can help retrieve and organise information using its available MCP capabilities. MCP approval and grants are independent of REST API access. Ask for the intended scope explicitly, and verify the assistant's reported coverage, pagination and missing data before sharing the output.
Keep API credentials out of report files and documentation. If a report is intended to be an archive, define the required scope and verify that each required resource was retrieved successfully.