SureCloud's External Rest API provides secure access to metadata stored in your SureCloud tenant. It allows Integration Administrators to bulk retrieve entity information and record data for synchronisation or analysis in external systems.
With this API, you can:
- Fetch a list of all entities available in your tenant.
- Retrieve all records for a given entity, including attribute values, workflow state and stage, linked records, and question answers.
- Retrieve a specific record for a given entity, including attribute values, workflow state and stage, linked records, and question answers.
- Create records for a given entity.
- Build integrations or reporting pipelines without needing to query each record individually.
Getting started guide
To start using the SureCloud External API:
- Request an API key from SureCloud
- Download Postman to view our documentation collection
- Import our Postman collection into your workspace and follow it's guide