> For the complete documentation index, see [llms.txt](https://surecloud.gitbook.io/surecloud-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://surecloud.gitbook.io/surecloud-docs/integrations/surecloud-external-api/getting-started-guide.md).

# Getting started guide

Use the **SureCloud External API** to retrieve metadata and record data from your tenant.

This API is designed for bulk access. It supports integrations, synchronisation, and external reporting.

With this API, you can:

* Retrieve the entities available in your tenant.
* Retrieve records in bulk, including attribute values, workflow state, stage, linked records, and question answers.
* Build integrations and reporting pipelines without querying each record individually.

***

{% stepper %}
{% step %}

### Request access credentials

Ask SureCloud to issue a JWT for your tenant and user.

Contact `success@surecloud.com` to request access.
{% endstep %}

{% step %}

### Import the Postman collection

Import the following collection into your Postman workspace.

{% file src="/files/vyKViWkEFgAXdUa1Xo4t" %}
{% endstep %}

{% step %}

### Set your collection variables

Set these variables before sending requests:

* `tenant` — your SureCloud tenant name from the URL.
* `apiKey` — the JWT provided by SureCloud.

{% hint style="info" %}
If you need more detail on tokens, see [Authentication](/surecloud-docs/integrations/surecloud-external-api/getting-started-guide/authentication.md).
{% endhint %}
{% endstep %}

{% step %}

### Send a request

Send `GET /workflows` to verify your setup.
{% endstep %}

{% step %}

### Retrieve records for a workflow

Use `GET /workflows/{workflowId}/records` to retrieve record data for a specific workflow.

Use the `workflowId` returned by `GET /workflows`.
{% endstep %}
{% endstepper %}